Sign in
Directory readiness

Start an OpenAI plugin-directory readiness run

Grades the saved server against OpenAI's plugin-directory requirements and returns 202 with a run id. submissionMode is required and never inferred: inferring it would read a forgotten package as mcp-only and report the package lane not-applicable, turning a missing input into a clean bill of health. Hosted runs grade the two wire-safe shapes; the package shapes need an upload this API cannot receive and are available from the CLI.

post/projects/{projectId}/servers/{serverId}/readiness-runs/openai

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

serverIdstring required

ID of the server inside the project.

Request body

submissionMode'mcp-only' | 'mcp-imported-skills' required

The declared submission shape.

idempotencyKeystring

Deduplicates a retried POST. More load-bearing here than usual: a readiness run dials a third party's server, and a retried start that created a second run would do that twice.

includeLlmObservationsboolean

Add model-backed experience observations. Consumes MCPJam credits. Off by default, and deliberately: a billed opt-in that defaulted on would start charging every existing caller on the day it shipped. Observations are non-dispositive and can never make a server not-ready; a refused reservation makes no provider call and completes the run with llmObservations.reason set to billing_limit_reached.

Response

The run was accepted and is executing.

runIdstring required
projectIdstring required
serverIdstring required
readinessKind'claude' | 'openai' required
status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required

The run's status when the start returned. pending for a fresh start; for a deduped start, whatever the existing run is already at — which may be completed, because a replayed idempotency key can name a run that finished long ago.

dedupedboolean required

This request replayed an existing run rather than starting one.

includeLlmObservationsboolean required

Changes

Changed in 2 of the 81 revisions of this API.53

  • 54895425280752See the full diff
    • ●

      added the new cancelled enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new completed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new failed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new pending enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new running enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

  • db933c9c315a1See the full diff
    • ○

      endpoint added

      endpoint-added