Farm.js Docs is an MCP server published by dev.farmjs, hosted at mcp.farmjs.dev. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 16 tools, including get_code_examples, get_config_schema, get_context, get_navigation, hydrate_content_changes.
Search and read the Farm.js docs: pages, sections, code examples and config options.
1,107 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Return fenced code examples from the docs with parsed metadata such as title, framework, packageManager, and runnable.
| Parameter | Type | Description |
|---|---|---|
| path | string | |
| limit | integer | |
| query | string | |
| locale | string | |
| language | string | |
| runnable | boolean | |
| framework | string | |
| packageManager | string |
{
"name": "get_code_examples",
"title": "Get docs code examples",
"description": "Return fenced code examples from the docs with parsed metadata such as title, framework, packageManager, and runnable.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"path": {
"type": "string",
"minLength": 1
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1
},
"query": {
"type": "string",
"minLength": 1
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"language": {
"type": "string",
"minLength": 1
},
"runnable": {
"type": "boolean"
},
"framework": {
"type": "string",
"minLength": 1
},
"packageManager": {
"type": "string",
"minLength": 1
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"examples"
],
"properties": {
"examples": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"page",
"runnable",
"meta",
"code"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"meta": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"boolean"
]
}
},
"page": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
},
"title": {
"type": "string"
},
"language": {
"type": "string"
},
"runnable": {
"type": "boolean"
},
"framework": {
"type": "string"
},
"packageManager": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Return structured docs.config.ts option metadata, optionally filtered by option path or query.
| Parameter | Type | Description |
|---|---|---|
| query | string | |
| option | string |
{
"name": "get_config_schema",
"title": "Get docs config schema",
"description": "Return structured docs.config.ts option metadata, optionally filtered by option path or query.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"query": {
"type": "string",
"minLength": 1
},
"option": {
"type": "string",
"minLength": 1
}
}
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"type": "object",
"required": [
"path",
"name",
"type",
"description"
],
"properties": {
"docs": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"default": {
"type": [
"string",
"boolean",
"number",
"null"
]
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"schemaVersion",
"configFile",
"description",
"resultCount",
"options",
"examples"
],
"properties": {
"filters": {
"type": "object",
"properties": {
"query": {
"type": "string"
},
"option": {
"type": "string"
}
},
"additionalProperties": false
},
"options": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"examples": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"code"
],
"properties": {
"code": {
"type": "string"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}
},
"configFile": {
"type": "string",
"const": "docs.config.ts"
},
"description": {
"type": "string"
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"schemaVersion": {
"type": "number",
"const": 1
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Build deterministic, section-level documentation context for a query within a conservative UTF-8 byte ceiling derived from the requested token budget, with source URLs and accounting metadata.
| Parameter | Type | Description |
|---|---|---|
| tags | any | |
| query * | string | |
| locale | string | |
| package | any | |
| version | string | |
| framework | string | |
| tokenBudget | integer |
{
"name": "get_context",
"title": "Get budgeted docs context",
"description": "Build deterministic, section-level documentation context for a query within a conservative UTF-8 byte ceiling derived from the requested token budget, with source URLs and accounting metadata.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"tags": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"query": {
"type": "string",
"minLength": 1
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"package": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"version": {
"type": "string",
"minLength": 1
},
"framework": {
"type": "string",
"minLength": 1
},
"tokenBudget": {
"type": "integer",
"default": 4000,
"maximum": 32000,
"minimum": 256
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query",
"filters",
"budget",
"resultCount",
"candidateCount",
"context",
"sources"
],
"properties": {
"query": {
"type": "string"
},
"budget": {
"type": "object",
"required": [
"requestedTokens",
"strategy",
"maxUtf8Bytes",
"usedUtf8Bytes",
"conservativeTokenUpperBound",
"remainingUtf8Bytes",
"truncated"
],
"properties": {
"strategy": {
"type": "string",
"const": "utf8-bytes"
},
"truncated": {
"type": "boolean"
},
"maxUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"usedUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"requestedTokens": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"remainingUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"conservativeTokenUpperBound": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"context": {
"type": "string"
},
"filters": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"locale": {
"type": "string"
},
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "string"
},
"framework": {
"type": "string"
}
},
"additionalProperties": false
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"pageUrl",
"url",
"content",
"chars",
"utf8Bytes",
"truncated"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"chars": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"score": {
"type": "number"
},
"title": {
"type": "string"
},
"anchor": {
"type": "string"
},
"locale": {
"type": "string"
},
"source": {
"type": "object",
"required": [
"canonicalUrl",
"scope",
"digest",
"indexGeneration"
],
"properties": {
"scope": {
"type": "object",
"required": [
"audience"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"locale": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"package": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"version": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"conflicts": {
"type": "array",
"items": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"maxItems": 4
},
"framework": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"truncated": {
"type": "array",
"items": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"maxItems": 4
},
"versionGroups": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"maxItems": 16
}
},
"additionalProperties": false
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"lastModified": {
"type": "string",
"maxLength": 256
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
}
},
"additionalProperties": false
},
"content": {
"type": "string"
},
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"pageUrl": {
"type": "string"
},
"section": {
"type": "string"
},
"version": {
"type": "string"
},
"framework": {
"type": "string"
},
"truncated": {
"type": "boolean"
},
"utf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"sourcePath": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"candidateCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Return the documentation navigation tree for the current docs site.
| Parameter | Type | Description |
|---|---|---|
| locale | string |
{
"name": "get_navigation",
"title": "Get docs navigation",
"description": "Return the documentation navigation tree for the current docs site.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
}
}
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"name",
"url"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"const": "page"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"name",
"children"
],
"properties": {
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"const": "folder"
},
"index": {
"type": "object",
"required": [
"type",
"name",
"url"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"const": "page"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"additionalProperties": false
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"navigation",
"markdown"
],
"properties": {
"markdown": {
"type": "string"
},
"navigation": {
"type": "object",
"required": [
"name",
"children"
],
"properties": {
"name": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Fetch only added and changed agent-facing sections after list_content_changes. Returns deletion tombstones and digest-bound continuation cursors under a conservative token budget.
| Parameter | Type | Description |
|---|---|---|
| since * | string | |
| cursor | string | Opaque nextCursor from the preceding response page. |
| locale | string | |
| tokenBudget | integer |
{
"name": "hydrate_content_changes",
"title": "Hydrate docs content changes",
"description": "Fetch only added and changed agent-facing sections after list_content_changes. Returns deletion tombstones and digest-bound continuation cursors under a conservative token budget.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"since"
],
"properties": {
"since": {
"type": "string"
},
"cursor": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"tokenBudget": {
"type": "integer",
"default": 5000,
"maximum": 32000,
"minimum": 4
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format",
"audience",
"since",
"indexGeneration",
"mode",
"resetRequired",
"documentCount",
"counts",
"budget",
"resultCount",
"total",
"hasMore",
"content",
"tombstones"
],
"properties": {
"mode": {
"enum": [
"snapshot",
"delta",
"reset"
],
"type": "string"
},
"since": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items in the complete filtered result set."
},
"budget": {
"type": "object",
"required": [
"requestedTokens",
"strategy",
"maxUtf8Bytes",
"usedUtf8Bytes",
"conservativeTokenUpperBound",
"remainingUtf8Bytes"
],
"properties": {
"strategy": {
"type": "string",
"const": "utf8-bytes"
},
"maxUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"usedUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"requestedTokens": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"remainingUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"conservativeTokenUpperBound": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"counts": {
"type": "object",
"required": [
"added",
"changed",
"deleted"
],
"properties": {
"added": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"changed": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"deleted": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"format": {
"type": "string",
"const": "docs-content-change-hydration.v1"
},
"locale": {
"type": "string"
},
"content": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"canonicalUrl",
"digest",
"type",
"change",
"section",
"sectionDigest",
"chunkDigest",
"chunk",
"content",
"utf8Bytes"
],
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string",
"const": "content"
},
"chunk": {
"type": "object",
"required": [
"index",
"count"
],
"properties": {
"count": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"index": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"change": {
"enum": [
"added",
"changed"
],
"type": "string"
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"content": {
"type": "string"
},
"section": {
"type": "object",
"required": [
"id",
"heading",
"level"
],
"properties": {
"id": {
"type": "string"
},
"level": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"heading": {
"type": "string"
}
},
"additionalProperties": false
},
"utf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"chunkDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"lastModified": {
"type": "string"
},
"sectionDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"previousDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"previousLastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean",
"description": "Whether another response page is available."
},
"audience": {
"type": "string",
"const": "agent"
},
"nextCursor": {
"type": "string",
"description": "Opaque cursor to pass as cursor on the next request."
},
"tombstones": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"canonicalUrl",
"digest",
"type",
"change"
],
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string",
"const": "tombstone"
},
"change": {
"type": "string",
"const": "deleted"
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items returned in this response page."
},
"documentCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"resetRequired": {
"type": "boolean"
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Synchronize body-free document metadata. Save indexGeneration and pass it as since on the next poll. A reset response means the named snapshot is no longer available.
| Parameter | Type | Description |
|---|---|---|
| since | string | |
| locale | string |
{
"name": "list_content_changes",
"title": "List docs content changes",
"description": "Synchronize body-free document metadata. Save indexGeneration and pass it as since on the next poll. A reset response means the named snapshot is no longer available.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"since": {
"type": "string"
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format",
"audience",
"since",
"indexGeneration",
"mode",
"resetRequired",
"documentCount",
"counts",
"added",
"changed",
"deleted"
],
"properties": {
"mode": {
"enum": [
"snapshot",
"delta",
"reset"
],
"type": "string"
},
"added": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"canonicalUrl",
"digest"
],
"properties": {
"url": {
"type": "string"
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"since": {
"anyOf": [
{
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
{
"type": "null"
}
]
},
"counts": {
"type": "object",
"required": [
"added",
"changed",
"deleted"
],
"properties": {
"added": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"changed": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"deleted": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"format": {
"type": "string",
"const": "docs-content-changes.v1"
},
"locale": {
"type": "string"
},
"changed": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"canonicalUrl",
"digest",
"previousDigest"
],
"properties": {
"url": {
"type": "string"
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"lastModified": {
"type": "string"
},
"previousDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"previousLastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"deleted": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"canonicalUrl",
"digest"
],
"properties": {
"url": {
"type": "string"
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"documentCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"resetRequired": {
"type": "boolean"
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}List documentation pages grouped by section, optionally narrowed to one section.
| Parameter | Type | Description |
|---|---|---|
| cursor | string | Opaque nextCursor from the preceding response page. |
| locale | string | |
| section | string |
{
"name": "list_docs",
"title": "List docs by section",
"description": "List documentation pages grouped by section, optionally narrowed to one section.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"cursor": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"section": {
"type": "string",
"minLength": 1
}
}
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"type": "object",
"required": [
"slug",
"title",
"pageCount",
"pages",
"sections"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"slug": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"enum": [
"page",
"api",
"code",
"changelog"
],
"type": "string"
},
"agent": {
"type": "object",
"required": [
"hasContract"
],
"properties": {
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"hasContract": {
"type": "boolean"
}
},
"additionalProperties": false
},
"title": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"title": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"pageCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"resultCount",
"total",
"hasMore",
"sectionCount",
"pages",
"rootPages",
"sections"
],
"properties": {
"pages": {
"type": "array",
"items": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"enum": [
"page",
"api",
"code",
"changelog"
],
"type": "string"
},
"agent": {
"type": "object",
"required": [
"hasContract"
],
"properties": {
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"hasContract": {
"type": "boolean"
}
},
"additionalProperties": false
},
"title": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items in the complete filtered result set."
},
"hasMore": {
"type": "boolean",
"description": "Whether another response page is available."
},
"section": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"rootPages": {
"type": "array",
"items": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"enum": [
"page",
"api",
"code",
"changelog"
],
"type": "string"
},
"agent": {
"type": "object",
"required": [
"hasContract"
],
"properties": {
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"hasContract": {
"type": "boolean"
}
},
"additionalProperties": false
},
"title": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"nextCursor": {
"type": "string",
"description": "Opaque cursor to pass as cursor on the next request."
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items returned in this response page."
},
"sectionCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Discover a page's canonical headings, anchors, hierarchy, line ranges, size estimates, and budget-aware fetch URLs without returning the page body.
| Parameter | Type | Description |
|---|---|---|
| path * | string | |
| cursor | string | Opaque nextCursor from the preceding response page. |
| locale | string | |
| byteBudget | integer | |
| tokenBudget | integer |
{
"name": "list_page_sections",
"title": "List sections in a docs page",
"description": "Discover a page's canonical headings, anchors, hierarchy, line ranges, size estimates, and budget-aware fetch URLs without returning the page body.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"minLength": 1
},
"cursor": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"byteBudget": {
"type": "integer",
"maximum": 1000000,
"minimum": 1
},
"tokenBudget": {
"type": "integer",
"maximum": 1000000,
"minimum": 1
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"schemaVersion",
"format",
"canonicalUrl",
"markdownUrl",
"sectionIndexUrl",
"lineNumbering",
"sectionCount",
"resultCount",
"total",
"hasMore",
"estimatedTokens",
"utf8Bytes",
"sections"
],
"properties": {
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items in the complete filtered result set."
},
"format": {
"type": "string",
"const": "docs-markdown-sections.v2"
},
"hasMore": {
"type": "boolean",
"description": "Whether another response page is available."
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"level",
"startLine",
"endLine",
"estimatedTokens",
"utf8Bytes",
"canonicalUrl",
"markdownUrl"
],
"properties": {
"id": {
"type": "string"
},
"level": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"endLine": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"heading": {
"type": "string"
},
"parentId": {
"type": "string"
},
"startLine": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"utf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"markdownUrl": {
"type": "string"
},
"canonicalUrl": {
"type": "string"
},
"estimatedTokens": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}
},
"utf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"nextCursor": {
"type": "string",
"description": "Opaque cursor to pass as cursor on the next request."
},
"fetchBudget": {
"type": "object",
"properties": {
"byteBudget": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"tokenBudget": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"markdownUrl": {
"type": "string"
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items returned in this response page."
},
"canonicalUrl": {
"type": "string"
},
"sectionCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"lineNumbering": {
"type": "string",
"const": "body"
},
"schemaVersion": {
"type": "number",
"const": 2
},
"estimatedTokens": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"sectionIndexUrl": {
"type": "string"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}List the known documentation pages with titles, slugs, and URLs.
| Parameter | Type | Description |
|---|---|---|
| cursor | string | Opaque nextCursor from the preceding response page. |
| locale | string |
{
"name": "list_pages",
"title": "List docs pages",
"description": "List the known documentation pages with titles, slugs, and URLs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"cursor": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"resultCount",
"total",
"hasMore",
"pages"
],
"properties": {
"pages": {
"type": "array",
"items": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"enum": [
"page",
"api",
"code",
"changelog"
],
"type": "string"
},
"agent": {
"type": "object",
"required": [
"hasContract"
],
"properties": {
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"hasContract": {
"type": "boolean"
}
},
"additionalProperties": false
},
"title": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
}
},
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items in the complete filtered result set."
},
"hasMore": {
"type": "boolean",
"description": "Whether another response page is available."
},
"nextCursor": {
"type": "string",
"description": "Opaque cursor to pass as cursor on the next request."
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items returned in this response page."
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}List valid framework, version, package, and tag filters with matching page counts before calling search_docs. Use facet, limit, and cursor to continue a large facet without document bodies.
| Parameter | Type | Description |
|---|---|---|
| tags | any | |
| facet | string | one of ["framework","version","package","tags"] |
| limit | integer | |
| cursor | string | Opaque nextCursor from the preceding response page. |
| locale | string | |
| package | any | |
| version | any | |
| audience | string | one of ["human","agent"] |
| framework | any |
{
"name": "list_search_facets",
"title": "List documentation search facets",
"description": "List valid framework, version, package, and tag filters with matching page counts before calling search_docs. Use facet, limit, and cursor to continue a large facet without document bodies.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"tags": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"facet": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"package": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"version": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"framework": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format",
"audience",
"filters",
"indexGeneration",
"matchedPageCount",
"facets"
],
"properties": {
"facets": {
"type": "object",
"required": [
"framework",
"version",
"package",
"tags"
],
"properties": {
"tags": {
"type": "object",
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"properties": {
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"values": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"count": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
},
"truncated": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"valueCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"package": {
"type": "object",
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"properties": {
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"values": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"count": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
},
"truncated": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"valueCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"version": {
"type": "object",
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"properties": {
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"values": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"count": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
},
"truncated": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"valueCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"framework": {
"type": "object",
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"properties": {
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"values": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"count": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
},
"truncated": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"valueCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"format": {
"type": "string",
"const": "docs-search-facets.v1"
},
"filters": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"matchedPageCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}List pages with actionable agent contracts, optionally filtered by text or applicability.
| Parameter | Type | Description |
|---|---|---|
| query | string | |
| cursor | string | Opaque nextCursor from the preceding response page. |
| locale | string | |
| package | string | |
| version | string | |
| framework | string |
{
"name": "list_tasks",
"title": "List documented tasks",
"description": "List pages with actionable agent contracts, optionally filtered by text or applicability.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"query": {
"type": "string",
"minLength": 1
},
"cursor": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"package": {
"type": "string",
"minLength": 1
},
"version": {
"type": "string",
"minLength": 1
},
"framework": {
"type": "string",
"minLength": 1
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"resultCount",
"total",
"hasMore",
"tasks"
],
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"slug": {
"type": "string"
},
"task": {
"type": "string"
},
"title": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
},
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items in the complete filtered result set."
},
"hasMore": {
"type": "boolean",
"description": "Whether another response page is available."
},
"nextCursor": {
"type": "string",
"description": "Opaque cursor to pass as cursor on the next request."
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items returned in this response page."
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Read a documentation page by slug or URL path, optionally selecting one heading and limiting returned characters.
| Parameter | Type | Description |
|---|---|---|
| path * | string | |
| locale | string | |
| section | string | |
| maxChars | integer |
{
"name": "read_page",
"title": "Read a docs page",
"description": "Read a documentation page by slug or URL path, optionally selecting one heading and limiting returned characters.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"minLength": 1
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"section": {
"type": "string",
"minLength": 1
},
"maxChars": {
"type": "integer",
"maximum": 1000000,
"minimum": 256
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"page",
"document",
"chars",
"totalChars",
"truncated"
],
"properties": {
"page": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"enum": [
"page",
"api",
"code",
"changelog"
],
"type": "string"
},
"title": {
"type": "string"
},
"locale": {
"type": "string"
},
"related": {
"type": "array",
"items": {
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string"
}
},
"additionalProperties": false
}
},
"version": {
"type": "string"
},
"framework": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
},
"chars": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"anchor": {
"type": "string"
},
"section": {
"type": "string"
},
"document": {
"type": "string"
},
"truncated": {
"type": "boolean"
},
"totalChars": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Read up to 20 documentation pages in one round trip. Results preserve request order and share a conservative UTF-8 token budget.
| Parameter | Type | Description |
|---|---|---|
| paths * | array | Page slugs or URL paths to read in the requested order. |
| locale | string | |
| tokenBudget | integer | |
| maxCharsPerPage | integer |
{
"name": "read_pages",
"title": "Read several docs pages",
"description": "Read up to 20 documentation pages in one round trip. Results preserve request order and share a conservative UTF-8 token budget.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"paths"
],
"properties": {
"paths": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Page slugs or URL paths to read in the requested order."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"tokenBudget": {
"type": "integer",
"maximum": 32000,
"minimum": 256
},
"maxCharsPerPage": {
"type": "integer",
"maximum": 1000000,
"minimum": 256
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format",
"budget",
"resultCount",
"requestedCount",
"pages",
"errors",
"remainingPaths"
],
"properties": {
"pages": {
"type": "array",
"items": {
"type": "object",
"required": [
"page",
"document",
"chars",
"totalChars",
"truncated",
"requestedPath"
],
"properties": {
"page": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"enum": [
"page",
"api",
"code",
"changelog"
],
"type": "string"
},
"title": {
"type": "string"
},
"locale": {
"type": "string"
},
"related": {
"type": "array",
"items": {
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string"
}
},
"additionalProperties": false
}
},
"version": {
"type": "string"
},
"framework": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
},
"chars": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"anchor": {
"type": "string"
},
"section": {
"type": "string"
},
"document": {
"type": "string"
},
"truncated": {
"type": "boolean"
},
"totalChars": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"requestedPath": {
"type": "string"
}
},
"additionalProperties": false
}
},
"budget": {
"type": "object",
"required": [
"requestedTokens",
"strategy",
"maxUtf8Bytes",
"usedUtf8Bytes",
"remainingUtf8Bytes",
"truncated"
],
"properties": {
"strategy": {
"type": "string",
"const": "utf8-bytes"
},
"truncated": {
"type": "boolean"
},
"maxUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"usedUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"requestedTokens": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"remainingUtf8Bytes": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"path",
"error"
],
"properties": {
"path": {
"type": "string"
},
"error": {
"type": "string"
}
},
"additionalProperties": false
}
},
"format": {
"type": "string",
"const": "docs-read-pages.v1"
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"remainingPaths": {
"type": "array",
"items": {
"type": "string"
}
},
"requestedCount": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Read the full structured agent contract for a page by slug or URL path.
| Parameter | Type | Description |
|---|---|---|
| path * | string | |
| locale | string | |
| section | string | |
| maxChars | integer |
{
"name": "read_task",
"title": "Read a documented task",
"description": "Read the full structured agent contract for a page by slug or URL path.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"minLength": 1
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"section": {
"type": "string",
"minLength": 1
},
"maxChars": {
"type": "integer",
"maximum": 1000000,
"minimum": 256
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"page",
"contract"
],
"properties": {
"page": {
"type": "object",
"required": [
"slug",
"url",
"title"
],
"properties": {
"url": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"description": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"additionalProperties": false
},
"contract": {
"type": "object",
"properties": {
"task": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"type": "string"
}
},
"outcome": {
"type": "string"
},
"commands": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"required": [
"run"
],
"properties": {
"cwd": {
"type": "string"
},
"run": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
]
}
},
"rollback": {
"type": "array",
"items": {
"type": "string"
}
},
"appliesTo": {
"type": "object",
"properties": {
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"sideEffects": {
"type": "array",
"items": {
"type": "string"
}
},
"tokenBudget": {
"type": "number"
},
"failureModes": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"required": [
"symptom"
],
"properties": {
"symptom": {
"type": "string"
},
"resolution": {
"type": "string"
}
},
"additionalProperties": false
}
]
}
},
"verification": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"run": {
"type": "string"
},
"expect": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
]
}
},
"prerequisites": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Search the docs by keyword with optional framework, version, package, and tag filters. Returns structured ambiguity and metadata warnings.
| Parameter | Type | Description |
|---|---|---|
| tags | any | |
| limit | integer | |
| query * | string | |
| cursor | string | Opaque nextCursor from the preceding response page. |
| locale | string | |
| explain | boolean | Include matched terms, scope decisions, ambiguity, and ranking reasons. |
| package | any | |
| version | any | |
| audience | string | one of ["human","agent"] |
| framework | any |
{
"name": "search_docs",
"title": "Search documentation",
"description": "Search the docs by keyword with optional framework, version, package, and tag filters. Returns structured ambiguity and metadata warnings.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"tags": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"limit": {
"type": "integer",
"maximum": 25,
"minimum": 1
},
"query": {
"type": "string",
"minLength": 1
},
"cursor": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"explain": {
"type": "boolean",
"description": "Include matched terms, scope decisions, ambiguity, and ranking reasons."
},
"package": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"version": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"framework": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 16,
"minItems": 1
}
]
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format",
"query",
"audience",
"filters",
"indexGeneration",
"resultCount",
"total",
"hasMore",
"results",
"warnings"
],
"properties": {
"query": {
"type": "string"
},
"total": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items in the complete filtered result set."
},
"format": {
"type": "string",
"const": "docs-search.v1"
},
"filters": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"framework": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"hasMore": {
"type": "boolean",
"description": "Whether another response page is available."
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url",
"content",
"type"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"type": {
"enum": [
"page",
"heading",
"text"
],
"type": "string"
},
"score": {
"type": "number"
},
"trust": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"source": {
"type": "object",
"required": [
"canonicalUrl",
"scope",
"digest",
"indexGeneration"
],
"properties": {
"scope": {
"type": "object",
"required": [
"audience"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"locale": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"package": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"version": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"conflicts": {
"type": "array",
"items": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"maxItems": 4
},
"framework": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"truncated": {
"type": "array",
"items": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"maxItems": 4
},
"versionGroups": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"maxItems": 16
}
},
"additionalProperties": false
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"lastModified": {
"type": "string",
"maxLength": 256
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
}
},
"additionalProperties": false
},
"content": {
"type": "string"
},
"section": {
"type": "string"
},
"description": {
"type": "string"
},
"explanation": {
"type": "object",
"required": [
"format",
"rank",
"rankingStrategy",
"matchedTerms",
"matchedTermsTruncated",
"selectedScope",
"filterDecisions",
"ambiguityResolution",
"rankingReasons"
],
"properties": {
"rank": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"format": {
"type": "string",
"const": "docs-search-explanation.v1"
},
"matchedTerms": {
"type": "array",
"items": {
"type": "object",
"required": [
"term",
"fields"
],
"properties": {
"term": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"enum": [
"title",
"section",
"description",
"content",
"url"
],
"type": "string"
}
}
},
"additionalProperties": false
}
},
"selectedScope": {
"anyOf": [
{
"type": "object",
"required": [
"audience"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"locale": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"package": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"version": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"conflicts": {
"type": "array",
"items": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"maxItems": 4
},
"framework": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"truncated": {
"type": "array",
"items": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"maxItems": 4
},
"versionGroups": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 16
},
"maxItems": 16
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"rankingReasons": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"description"
],
"properties": {
"code": {
"enum": [
"literal_match",
"title_phrase",
"section_phrase",
"title_section_phrase",
"url_phrase",
"description_phrase",
"content_phrase",
"title_terms",
"section_terms",
"description_terms",
"content_terms",
"all_terms_in_section",
"all_terms_in_title",
"all_query_terms",
"heading_boost",
"exact_page_boost",
"provider_order",
"literal_result_priority",
"stable_url_tiebreak"
],
"type": "string"
},
"description": {
"type": "string"
},
"contribution": {
"type": "number"
}
},
"additionalProperties": false
}
},
"filterDecisions": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"requestedValues",
"selectedValues",
"matchedValues",
"outcome"
],
"properties": {
"field": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"outcome": {
"enum": [
"not_requested",
"matched",
"not_verifiable"
],
"type": "string"
},
"matchedValues": {
"type": "array",
"items": {
"type": "string"
}
},
"selectedValues": {
"type": "array",
"items": {
"type": "string"
}
},
"requestedValues": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"rankingStrategy": {
"enum": [
"lexical",
"exact",
"provider"
],
"type": "string"
},
"ambiguityResolution": {
"type": "object",
"required": [
"status",
"decisions"
],
"properties": {
"status": {
"enum": [
"unambiguous",
"resolved",
"unresolved",
"not_verifiable"
],
"type": "string"
},
"decisions": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"status",
"selectedValues",
"reason"
],
"properties": {
"field": {
"enum": [
"framework",
"version",
"package"
],
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"enum": [
"unambiguous",
"resolved_by_filter",
"requires_filter",
"not_verifiable"
],
"type": "string"
},
"selectedValues": {
"type": "array",
"items": {
"type": "string"
}
},
"candidateValues": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"matchedTermsTruncated": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"audience": {
"enum": [
"human",
"agent"
],
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"field",
"message"
],
"properties": {
"code": {
"enum": [
"ambiguous_scope",
"unknown_filter_value",
"missing_scope_metadata",
"conflicting_scope_metadata"
],
"type": "string"
},
"count": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"field": {
"enum": [
"framework",
"version",
"package",
"tags"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"pageUrls": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"nextCursor": {
"type": "string",
"description": "Opaque cursor to pass as cursor on the next request."
},
"resultCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Items returned in this response page."
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true
}
}Submit machine-readable documentation feedback. The payload is validated against the site's configured agent feedback schema before delivery.
| Parameter | Type | Description |
|---|---|---|
| context | object | |
| payload * | object |
{
"name": "submit_feedback",
"title": "Submit documentation feedback",
"description": "Submit machine-readable documentation feedback. The payload is validated against the site's configured agent feedback schema before delivery.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"payload"
],
"properties": {
"context": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"page": {
"type": "string"
},
"slug": {
"type": "string"
},
"locale": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"payload": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"accepted",
"message"
],
"properties": {
"message": {
"type": "string"
},
"accepted": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.