> ## Documentation Index > Fetch the complete documentation index at: https://docs.mcpjam.com/llms.txt > Use this file to discover all available pages before exploring further. # List readiness runs ## OpenAPI ````yaml /reference/openapi.json get /projects/{projectId}/readiness-runs openapi: 3.1.0 info: title: MCPJam API version: 1.0.0-preview description: >- Programmatic access to MCP servers saved in your MCPJam projects — live diagnostics (validate, inspect, export) and operations: call tools, render prompts, run eval suites asynchronously and poll their results, and import OAuth tokens. **The API is in preview**: the surface may change while we finish the design. Error `code` values are stable; error `message` strings are not. Write clients that ignore unknown response fields. contact: name: MCPJam url: https://github.com/MCPJam/inspector/issues servers: - url: https://app.mcpjam.com/api/v1 description: Hosted MCPJam security: - bearerAuth: [] tags: - name: Hosts description: >- Project hosts: named model + capability profiles you run chats and eval suites against. - name: Environments description: >- Project environments: named, live-editable execution bundles (one host, an optional standalone server group, optionally pinned skills and plugin versions) that eval suites and journeys run against. Distinct from Sandbox images, which are Computer base images. Reads require project membership; every write requires project admin. - name: Plugins description: >- Agent Plugins imported into a project — read-only inventory and version detail. - name: Sandbox images description: >- Custom Computer images: a digest-pinned Dockerfile built into an immutable image your project's computers boot from. - name: Server diagnostics description: Connect-level health checks against a saved MCP server. - name: Primitives description: 'The server''s MCP primitives: tools, prompts, and resources.' - name: Export description: Full-server snapshots for diffing and CI. - name: Execution description: 'Run the server''s primitives: call tools, render prompts.' - name: Eval runs description: >- Asynchronous eval suite runs: create with 202, poll status, iterations, and traces. - name: Conformance runs description: >- Ingest MCP spec-conformance results from the SDK/CLI into project-owned history. Distinct from Eval runs (authored LLM cases) and from directory readiness. - name: Server connections description: >- Connect an MCP server URL to a project, authorizing in a browser when the server requires it. - name: OAuth description: 'Bring-your-own OAuth: import externally obtained tokens for a server.' - name: Scenarios description: >- Read-only access to the scenarios published from a project: listing, settings, attached servers, and share links. - name: Catalog description: >- Discover the resources the other routes operate on: your account, projects, servers, eval suites, and chat sessions. - name: Tunnels description: >- Relay tunnels that expose local MCP servers through a public URL, registered as first-class project servers (the `mcpjam cloud tunnel` CLI flow). - name: Agent description: >- Headless agent turns over the public API: send a message history, the server runs one assistant turn with project-scoped workspace tools (eval reads + suite creation) on a pinned hosted model, and returns the reply plus created-resource references. - name: Swarms description: >- Personas, journeys and swarm containers — the authoring half of Swarms — plus the model-backed generation that drafts them. - name: Swarm runs description: >- Launching journeys and reading what they produced. Launching SPENDS — see the per-operation notes. - name: Swarm insights description: >- What a swarm run revealed. The scorecard and findings are deterministic and free; requesting wave insights runs models and draws on your shared daily ledger. - name: User testing description: >- Publishing an environment for real visitors, and controlling who can reach it. Several of these NARROW access and take effect immediately. - name: Directory readiness description: >- Grade a saved server against a publisher's listing requirements: Anthropic's connector directory or OpenAI's plugin directory. Reported as lane status and coverage, never as a numeric score, and excluded from `pooledConformanceScore`. Deterministic grading is free; model-backed experience observations are an explicit opt-in that consumes MCPJam credits and can never decide a verdict. - name: Registry description: >- Search the scraped MCP directories (Claude, ChatGPT, and any future source), list curated/org registry cards, and install them into a project. Install writes a `servers` row and provenance — it does not open a live session. There is no catalog-uninstall route: delete the project server instead. Directory reads require a bearer (including minted guest tokens) but do not materialize a user. Card/connection reads and all writes are authed-non-guest. paths: /projects/{projectId}/readiness-runs: get: tags: - Directory readiness summary: List readiness runs operationId: listReadinessRuns parameters: - $ref: '#/components/parameters/projectId' - name: readinessKind in: query required: false schema: type: string enum: - claude - openai description: Narrow to one publisher. Omitted lists both, newest first. - name: serverId in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 responses: '200': description: A page of runs. content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/ReadinessRun' nextCursor: type: string nullable: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: parameters: projectId: name: projectId in: path required: true description: ID of the hosted project that contains the server. schema: type: string schemas: ReadinessRun: type: object description: >- A directory-readiness run. Readiness carries no numeric score and is excluded from `pooledConformanceScore`: it answers whether a publisher would list this server, which is a different question from whether the server speaks MCP correctly. required: - id - readinessKind - serverId - serverUrl - submissionMode - status - overallStatus - lanes - stages - authMode - capabilities - attemptCount - terminalReason - errorMessage - policySnapshotDate - engineVersion - sdkVersion - includeLlmObservations - llmObservations - hasReport - reportUrl - createdAt - updatedAt properties: id: type: string readinessKind: type: string enum: - claude - openai serverId: type: string nullable: true description: >- The saved project server this run graded. Null only on rows written before the field existed. serverUrl: type: string description: >- The saved server's URL exactly as stored. Canonicalizing it would change the grade. submissionMode: type: string nullable: true enum: - mcp-only - mcp-imported-skills description: The declared submission shape, for an OpenAI run. Never inferred. status: type: string enum: - pending - running - completed - failed - cancelled description: >- `cancelled` is distinct from `failed`: a person who stopped a run has learned nothing about their server. overallStatus: type: string nullable: true enum: - ready - not-ready - incomplete description: >- The headline verdict. `incomplete` means nothing was violated and something the run needed was never evaluated. lanes: type: array items: $ref: '#/components/schemas/ReadinessLaneCoverage' stages: type: array items: $ref: '#/components/schemas/ReadinessStageResult' authMode: type: string nullable: true enum: - headless - interactive - provided-token capabilities: type: array items: type: string description: >- What the executing surface could actually do. Two surfaces grading one target agree only on their shared capability subset. attemptCount: type: integer terminalReason: type: string nullable: true errorMessage: type: string nullable: true policySnapshotDate: type: string nullable: true description: >- The publisher-documentation snapshot this run graded against, so a stale grade says so. engineVersion: type: string nullable: true sdkVersion: type: string nullable: true includeLlmObservations: type: boolean description: Whether this run was started with the paid observation opt-in. llmObservations: $ref: '#/components/schemas/ReadinessObservationState' hasReport: type: boolean reportUrl: type: string nullable: true createdAt: type: integer updatedAt: type: integer ReadinessLaneCoverage: type: object description: >- What one lane managed to look at, reported separately from what it found. A lane with zero violations and zero evaluated checks is not a pass, and publishing the denominator is the only way to keep those apart. required: - lane - status - evaluated - notEvaluated - notApplicable - missingInputs properties: lane: type: string enum: - runtime-compatibility - directory-policy - optional-features - submission-artifacts - experience-insights - plugin-package - release-contract description: >- Anthropic defines five lanes and OpenAI seven, overlapping on four. Which subset applies is decided by the run's `readinessKind`. status: type: string enum: - ready - not-ready - incomplete evaluated: type: integer description: Findings that reached a satisfied or violated verdict. notEvaluated: type: integer description: Applicable but never exercised. Each one is an unanswered question. notApplicable: type: integer description: Could not apply to this target; not a gap. missingInputs: type: array items: type: string description: >- Named inputs the caller could supply to close the gap, for example `toolListing`. Empty when the gap is not the caller's to close. ReadinessStageResult: type: object description: >- One staged rollup. OpenAI grades a quick technical preflight and a full submission-ready verdict from the same findings; Claude has one rollup, already reported as `overallStatus`. required: - stage - status - lanes properties: stage: type: string enum: - technical-preflight - submission-ready status: type: string enum: - ready - not-ready - incomplete lanes: type: array items: type: string enum: - runtime-compatibility - directory-policy - optional-features - submission-artifacts - experience-insights - plugin-package - release-contract description: >- The lanes this stage rolled up, so the verdict is reproducible by hand. ReadinessObservationState: type: object description: >- The model-observation axis, independent of the run's own status. A run whose lanes graded cleanly is `completed` even when the observation call was refused for credit: a payment problem belongs to the account, never to the server under grading. required: - status properties: status: type: string enum: - not-requested - pending - completed - billing-blocked - provider-failed - invalid-output reason: type: string enum: - not_requested - billing_limit_reached - provider_error - provider_timeout - schema_invalid - no_evidence - cancelled description: >- Machine-readable, so a client branches rather than string-matching. `billing_limit_reached` is the value to key a top-up prompt on. detail: type: string description: A sentence for a human. Never parse it; branch on `reason`. Error: type: object required: - code - message properties: code: type: string description: >- Stable, machine-readable error code. New codes may be added over time; treat unknown codes as non-retryable failures unless the HTTP status says otherwise. enum: - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - VALIDATION_ERROR - RATE_LIMITED - FEATURE_NOT_SUPPORTED - SERVER_UNREACHABLE - TIMEOUT - OAUTH_REQUIRED - INTERNAL_ERROR message: type: string description: >- Human-readable description. May change between releases — don't match on it. details: type: object description: Optional, unstructured context bag. additionalProperties: true responses: Unauthorized: description: >- Missing, invalid, revoked, or orphaned key (`UNAUTHORIZED`) — or the **target MCP server** needs an OAuth grant (`OAUTH_REQUIRED`), which is a property of the server, not your key. content: application/json: schema: $ref: '#/components/schemas/Error' examples: badKey: summary: Invalid or revoked key value: code: UNAUTHORIZED message: Invalid API key oauthRequired: summary: Target server needs an OAuth grant value: code: OAUTH_REQUIRED message: Server requires OAuth authorization Forbidden: description: Key is valid but not allowed to do this. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: FORBIDDEN message: You do not have access to this project NotFound: description: Unknown project, server, or resource. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: NOT_FOUND message: Server not found RateLimited: description: >- Per-key rate limit exceeded (60 requests/minute sustained, bursts up to 10). Honor `Retry-After` and back off with jitter. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' example: code: RATE_LIMITED message: API key rate limit exceeded. Slow down and retry. InternalError: description: Something failed on MCPJam's side. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: INTERNAL_ERROR message: Unexpected internal error securitySchemes: bearerAuth: type: http scheme: bearer description: >- MCPJam API key (`sk_…`). Create one at [Settings → API keys](https://app.mcpjam.com/settings/api-keys). Guest sessions cannot use the API, and API keys cannot manage other API keys. ````