> For the complete documentation index, see [llms.txt](https://docs.mozilla.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mozilla.ai/mcpd/reference/api-reference.md).

# API Reference

{% hint style="info" %}
Interactive reference generated from the mcpd OpenAPI specification.
{% endhint %}

## Health

## GET /api/v1/health/servers

> List the health statuses for all servers

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/health/servers":{"get":{"operationId":"listServersHealth","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServersHealthResponseBody"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"List the health statuses for all servers","tags":["Health"]}}},"components":{"schemas":{"ServersHealthResponseBody":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"servers":{"description":"Tracked MCP server health statuses","items":{"$ref":"#/components/schemas/ServerHealth"},"type":["array","null"]}},"required":["servers"],"type":"object"},"ServerHealth":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"lastChecked":{"format":"date-time","type":"string"},"lastSuccessful":{"format":"date-time","type":"string"},"latency":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}},"required":["name","status"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## GET /api/v1/health/servers/{name}

> Get the health status of a server

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/health/servers/{name}":{"get":{"operationId":"getServerHealth","parameters":[{"description":"Name of the server to check","in":"path","name":"name","required":true,"schema":{"description":"Name of the server to check","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerHealth"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"Get the health status of a server","tags":["Health"]}}},"components":{"schemas":{"ServerHealth":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"lastChecked":{"format":"date-time","type":"string"},"lastSuccessful":{"format":"date-time","type":"string"},"latency":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}},"required":["name","status"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## Prompts

## GET /api/v1/servers/{name}/prompts

> List server prompt templates

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers/{name}/prompts":{"get":{"operationId":"listPrompts","parameters":[{"description":"Name of the server","in":"path","name":"name","required":true,"schema":{"description":"Name of the server","type":"string"}},{"description":"Pagination cursor","explode":false,"in":"query","name":"cursor","schema":{"description":"Pagination cursor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prompts"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"List server prompt templates","tags":["Prompts"]}}},"components":{"schemas":{"Prompts":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"nextCursor":{"type":"string"},"prompts":{"items":{"$ref":"#/components/schemas/Prompt"},"type":["array","null"]}},"required":["prompts"],"type":"object"},"Prompt":{"additionalProperties":false,"properties":{"_meta":{"additionalProperties":{},"type":"object"},"arguments":{"items":{"$ref":"#/components/schemas/PromptArgument"},"type":["array","null"]},"description":{"type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"PromptArgument":{"additionalProperties":false,"properties":{"description":{"type":"string"},"name":{"type":"string"},"required":{"type":"boolean"}},"required":["name"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## Generate a prompt from a server template

> Generates a prompt by filling in a template with the provided arguments

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers/{name}/prompts/{promptName}":{"post":{"description":"Generates a prompt by filling in a template with the provided arguments","operationId":"generatePrompt","parameters":[{"description":"Name of the server","in":"path","name":"name","required":true,"schema":{"description":"Name of the server","type":"string"}},{"description":"Name of the prompt","in":"path","name":"promptName","required":true,"schema":{"description":"Name of the prompt","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptGenerateArguments","description":"Prompt arguments"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratePromptResponseBody"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"Generate a prompt from a server template","tags":["Prompts"]}}},"components":{"schemas":{"PromptGenerateArguments":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"arguments":{"additionalProperties":{"type":"string"},"description":"Arguments for templating the prompt","type":"object"}},"type":"object"},"GeneratePromptResponseBody":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"description":{"type":"string"},"messages":{"items":{"$ref":"#/components/schemas/PromptMessage"},"type":["array","null"]}},"required":["messages"],"type":"object"},"PromptMessage":{"additionalProperties":false,"properties":{"content":{},"role":{"type":"string"}},"required":["role","content"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## Resources

## GET /api/v1/servers/{name}/resources

> List server resources

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers/{name}/resources":{"get":{"operationId":"listResources","parameters":[{"description":"Name of the server","in":"path","name":"name","required":true,"schema":{"description":"Name of the server","type":"string"}},{"description":"Pagination cursor","explode":false,"in":"query","name":"cursor","schema":{"description":"Pagination cursor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resources"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"List server resources","tags":["Resources"]}}},"components":{"schemas":{"Resources":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"nextCursor":{"type":"string"},"resources":{"items":{"$ref":"#/components/schemas/Resource"},"type":["array","null"]}},"required":["resources"],"type":"object"},"Resource":{"additionalProperties":false,"properties":{"_meta":{"additionalProperties":{},"type":"object"},"description":{"type":"string"},"mimeType":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"}},"required":["uri","name"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## Get resource content from a server

> Retrieves the content of a resource by URI

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers/{name}/resources/content":{"get":{"description":"Retrieves the content of a resource by URI","operationId":"getResourceContent","parameters":[{"description":"Name of the server","in":"path","name":"name","required":true,"schema":{"description":"Name of the server","type":"string"}},{"description":"URI of the resource","explode":false,"in":"query","name":"uri","schema":{"description":"URI of the resource","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResourceContent"},"type":["array","null"]}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"Get resource content from a server","tags":["Resources"]}}},"components":{"schemas":{"ResourceContent":{"additionalProperties":false,"properties":{"_meta":{"additionalProperties":{},"type":"object"},"blob":{"type":"string"},"mimeType":{"type":"string"},"text":{"type":"string"},"uri":{"type":"string"}},"required":["uri"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## GET /api/v1/servers/{name}/resources/templates

> List server resource templates

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers/{name}/resources/templates":{"get":{"operationId":"listResourceTemplates","parameters":[{"description":"Name of the server","in":"path","name":"name","required":true,"schema":{"description":"Name of the server","type":"string"}},{"description":"Pagination cursor","explode":false,"in":"query","name":"cursor","schema":{"description":"Pagination cursor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceTemplates"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"List server resource templates","tags":["Resources"]}}},"components":{"schemas":{"ResourceTemplates":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"nextCursor":{"type":"string"},"templates":{"items":{"$ref":"#/components/schemas/ResourceTemplate"},"type":["array","null"]}},"required":["templates"],"type":"object"},"ResourceTemplate":{"additionalProperties":false,"properties":{"_meta":{"additionalProperties":{},"type":"object"},"description":{"type":"string"},"mimeType":{"type":"string"},"name":{"type":"string"},"uriTemplate":{"type":"string"}},"required":["uriTemplate","name"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## Servers

## GET /api/v1/servers

> List all servers

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers":{"get":{"operationId":"listServers","responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":["array","null"]}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"List all servers","tags":["Servers"]}}},"components":{"schemas":{"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## Tools

## List server tools

> Returns tools with configurable detail level via ?detail= query parameter (minimal, summary, full)

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers/{name}/tools":{"get":{"description":"Returns tools with configurable detail level via ?detail= query parameter (minimal, summary, full)","operationId":"listTools","parameters":[{"description":"Name of the server to lookup tools for","in":"path","name":"name","required":true,"schema":{"description":"Name of the server to lookup tools for","type":"string"}},{"description":"Level of detail to return","explode":false,"in":"query","name":"detail","schema":{"default":"full","description":"Level of detail to return","enum":["minimal","summary","full"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolsResponseBodyTool"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"List server tools","tags":["Tools"]}}},"components":{"schemas":{"ToolsResponseBodyTool":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"tools":{"items":{"$ref":"#/components/schemas/Tool"},"type":["array","null"]}},"required":["tools"],"type":"object"},"Tool":{"additionalProperties":false,"properties":{"_meta":{"additionalProperties":{},"description":"Additional metadata","type":"object"},"annotations":{"$ref":"#/components/schemas/ToolAnnotations","description":"Additional hints about the tool"},"description":{"description":"Description of what the tool does","type":"string"},"inputSchema":{"$ref":"#/components/schemas/JSONSchema","description":"Input parameters schema"},"name":{"description":"Name of the tool","type":"string"},"outputSchema":{"$ref":"#/components/schemas/JSONSchema","description":"Output structure schema"},"title":{"description":"Human-readable title","type":"string"}},"required":["description","name"],"type":"object"},"ToolAnnotations":{"additionalProperties":false,"properties":{"destructiveHint":{"type":"boolean"},"idempotentHint":{"type":"boolean"},"openWorldHint":{"type":"boolean"},"readOnlyHint":{"type":"boolean"},"title":{"type":"string"}},"type":"object"},"JSONSchema":{"additionalProperties":false,"properties":{"$defs":{"additionalProperties":{},"type":"object"},"additionalProperties":{},"properties":{"additionalProperties":{},"type":"object"},"required":{"items":{"type":"string"},"type":["array","null"]},"type":{"type":"string"}},"required":["type"],"type":"object"},"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```

## POST /api/v1/servers/{server}/tools/{tool}

> Call a tool for a server

```json
{"openapi":"3.1.0","info":{"title":"mcpd docs","version":"v1"},"paths":{"/api/v1/servers/{server}/tools/{tool}":{"post":{"operationId":"callTool","parameters":[{"description":"Name of the server","in":"path","name":"server","required":true,"schema":{"description":"Name of the server","type":"string"}},{"description":"Name of the tool to call","in":"path","name":"tool","required":true,"schema":{"description":"Name of the tool to call","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":{},"description":"Body of the tool to call","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"OK"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Error"}},"summary":"Call a tool for a server","tags":["Tools"]}}},"components":{"schemas":{"ErrorModel":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","format":"uri","readOnly":true,"type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"errors":{"description":"Optional list of individual error details","items":{"$ref":"#/components/schemas/ErrorDetail"},"type":["array","null"]},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","format":"uri","type":"string"},"status":{"description":"HTTP status code","format":"int64","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","type":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","format":"uri","type":"string"}},"type":"object"},"ErrorDetail":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mozilla.ai/mcpd/reference/api-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.