> ## Documentation Index > Fetch the complete documentation index at: https://mcpjam-mintlify-docs-update-pr-3812-1786323532738.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Run the doctor > Runs the full doctor workflow — probe → connect → initialize → capabilities → primitives — and returns a step-by-step report. The richest signal for "is this server healthy, and why not." ## OpenAPI ````yaml /reference/openapi.json post /projects/{projectId}/servers/{serverId}/doctor 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: 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: OAuth description: 'Bring-your-own OAuth: import externally obtained tokens for a server.' - name: Chatboxes description: >- Read-only access to the chatboxes 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 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. paths: /projects/{projectId}/servers/{serverId}/doctor: post: tags: - Server diagnostics summary: Run the doctor description: >- Runs the full doctor workflow — probe → connect → initialize → capabilities → primitives — and returns a step-by-step report. The richest signal for "is this server healthy, and why not." operationId: runDoctor parameters: - $ref: '#/components/parameters/projectId' - $ref: '#/components/parameters/serverId' requestBody: $ref: '#/components/requestBodies/emptyBody' responses: '200': description: >- Doctor report. `status` summarizes the outcome; per-step detail is in `checks`. content: application/json: schema: $ref: '#/components/schemas/DoctorReport' '400': $ref: '#/components/responses/ValidationError' '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' '502': $ref: '#/components/responses/ServerUnreachable' '504': $ref: '#/components/responses/Timeout' components: parameters: projectId: name: projectId in: path required: true description: ID of the hosted project that contains the server. schema: type: string serverId: name: serverId in: path required: true description: ID of the server inside the project. schema: type: string requestBodies: emptyBody: required: false description: Accepts an empty JSON object. content: application/json: schema: type: object properties: {} example: {} schemas: DoctorReport: type: object description: >- Step-by-step health report from the probe → connect → initialize → capabilities workflow. required: - generatedAt - status - connection - checks properties: generatedAt: type: string format: date-time description: When the report was generated. status: type: string enum: - ready - oauth_required - partial - error description: >- Overall outcome. `partial` means the server connected but some primitive listings failed. probe: type: - object - 'null' description: >- Transport-level probe result (HTTP reachability, protocol hints), or `null` when skipped. additionalProperties: true connection: type: object required: - status - detail properties: status: type: string enum: - connected - error - skipped detail: type: string initInfo: type: - object - 'null' additionalProperties: true capabilities: type: - object - 'null' description: The server's negotiated MCP capabilities. additionalProperties: true tools: type: array items: $ref: '#/components/schemas/Tool' resources: type: array items: $ref: '#/components/schemas/Resource' resourceTemplates: type: array items: type: object additionalProperties: true prompts: type: array items: $ref: '#/components/schemas/Prompt' checks: type: object description: >- Per-step status. Each check is `{ status: ok | error | skipped, detail }`. properties: probe: $ref: '#/components/schemas/DoctorCheck' connection: $ref: '#/components/schemas/DoctorCheck' initialization: $ref: '#/components/schemas/DoctorCheck' capabilities: $ref: '#/components/schemas/DoctorCheck' tools: $ref: '#/components/schemas/DoctorCheck' resources: $ref: '#/components/schemas/DoctorCheck' resourceTemplates: $ref: '#/components/schemas/DoctorCheck' prompts: $ref: '#/components/schemas/DoctorCheck' error: oneOf: - type: 'null' - type: object required: - code - message properties: code: type: string message: type: string details: {} description: Terminal error, or `null` when the workflow completed. additionalProperties: true Tool: type: object description: MCP tool definition, as returned by the server. required: - name properties: name: type: string description: type: string inputSchema: type: object description: JSON Schema for the tool's arguments. additionalProperties: true outputSchema: type: object description: JSON Schema for the tool's structured output, when declared. additionalProperties: true additionalProperties: true Resource: type: object description: MCP resource descriptor, as returned by the server. required: - uri properties: uri: type: string name: type: string description: type: string mimeType: type: string additionalProperties: true Prompt: type: object description: MCP prompt definition, as returned by the server. required: - name properties: name: type: string description: type: string arguments: type: array items: type: object required: - name properties: name: type: string description: type: string required: type: boolean additionalProperties: true additionalProperties: true DoctorCheck: type: object required: - status - detail properties: status: type: string enum: - ok - error - skipped detail: type: string 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: ValidationError: description: Malformed body or parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: VALIDATION_ERROR message: Invalid JSON body 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 ServerUnreachable: description: Could not connect to the target MCP server. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: SERVER_UNREACHABLE message: Failed to connect to server Timeout: description: The target MCP server connected but didn't respond in time. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: TIMEOUT message: Request to server timed out 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. ````