Farm.js Docs
Search and read the Farm.js docs: pages, sections, code examples and config options.
사용해야 할까요
품질 및 안전성
A
발견 사항 (1)
- LOWTool 'get_navigation' description lacks action verbget_navigation에서
도구 정의와 프로토콜 준수에 대한 자동 분석을 기반으로 합니다.
컨텍스트 비용
~7,149토큰 (도구 정의)
~8.0 KB일반적인 응답 크기
상당한 주의 영향 (128k 컨텍스트의 5.59%)
이는 서버의 도구가 모델의 컨텍스트에 로드될 때마다 소비되는 대략적인 토큰 수입니다. 수치가 높을수록 다른 작업에 사용할 수 있는 주의가 줄어듭니다.
설치
원클릭 설치
`claude_desktop_config.json` 파일에 다음을 추가하세요:
{
"mcpServers": {
"docs": {
"url": "https://mcp.farmjs.dev/mcp"
}
}
}원격 엔드포인트
https://mcp.farmjs.dev/mcpstreamable-http할 수 있는 일
도구 목록
도구 (10)
🟢 읽기 전용🟡 쓰기🔴 삭제⚪ 알 수 없음
🟢get_code_examples(query, path, framework, packageManager, language, ...)
Return fenced code examples from the docs with parsed metadata such as title, framework, packageManager, and runnable.
입력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string",
"minLength": 1
},
"framework": {
"type": "string",
"minLength": 1
},
"packageManager": {
"type": "string",
"minLength": 1
},
"language": {
"type": "string",
"minLength": 1
},
"runnable": {
"type": "boolean"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"examples": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"page": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"required": [
"slug",
"url",
"title"
],
"additionalProperties": false
},
"language": {
"type": "string"
},
"title": {
"type": "string"
},
"framework": {
"type": "string"
},
"packageManager": {
"type": "string"
},
"runnable": {
"type": "boolean"
},
"meta": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"boolean"
]
}
},
"code": {
"type": "string"
}
},
"required": [
"id",
"page",
"runnable",
"meta",
"code"
],
"additionalProperties": false
}
}
},
"required": [
"examples"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢get_config_schema(option, query)
Return structured docs.config.ts option metadata, optionally filtered by option path or query.
입력 스키마
{
"type": "object",
"properties": {
"option": {
"type": "string",
"minLength": 1
},
"query": {
"type": "string",
"minLength": 1
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"schemaVersion": {
"type": "number",
"const": 1
},
"configFile": {
"type": "string",
"const": "docs.config.ts"
},
"description": {
"type": "string"
},
"filters": {
"type": "object",
"properties": {
"option": {
"type": "string"
},
"query": {
"type": "string"
}
},
"additionalProperties": false
},
"resultCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"options": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"examples": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": [
"title",
"code"
],
"additionalProperties": false
}
}
},
"required": [
"schemaVersion",
"configFile",
"description",
"resultCount",
"options",
"examples"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"default": {
"type": [
"string",
"boolean",
"number",
"null"
]
},
"description": {
"type": "string"
},
"docs": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"path",
"name",
"type",
"description"
],
"additionalProperties": false
}
}
}🟢get_context(query, framework, version, package, tags, ...)
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.
입력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1
},
"framework": {
"type": "string",
"minLength": 1
},
"version": {
"type": "string",
"minLength": 1
},
"package": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 128
},
{
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
]
},
"tags": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 128
},
{
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
]
},
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"tokenBudget": {
"default": 4000,
"type": "integer",
"minimum": 256,
"maximum": 32000
}
},
"required": [
"query"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string"
},
"filters": {
"type": "object",
"properties": {
"framework": {
"type": "string"
},
"version": {
"type": "string"
},
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"locale": {
"type": "string"
}
},
"additionalProperties": false
},
"budget": {
"type": "object",
"properties": {
"requestedTokens": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"strategy": {
"type": "string",
"const": "utf8-bytes"
},
"maxUtf8Bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"usedUtf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"conservativeTokenUpperBound": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"remainingUtf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"truncated": {
"type": "boolean"
}
},
"required": [
"requestedTokens",
"strategy",
"maxUtf8Bytes",
"usedUtf8Bytes",
"conservativeTokenUpperBound",
"remainingUtf8Bytes",
"truncated"
],
"additionalProperties": false
},
"resultCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"candidateCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"pageUrl": {
"type": "string"
},
"url": {
"type": "string"
},
"section": {
"type": "string"
},
"anchor": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"lastModified": {
"type": "string"
},
"locale": {
"type": "string"
},
"framework": {
"type": "string"
},
"version": {
"type": "string"
},
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"type": "object",
"properties": {
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"scope": {
"type": "object",
"properties": {
"audience": {
"type": "string",
"enum": [
"human",
"agent"
]
},
"locale": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 128
}
},
"framework": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 128
}
},
"version": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 128
}
},
"versionGroups": {
"maxItems": 16,
"type": "array",
"items": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 128
}
}
},
"package": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 128
}
},
"tags": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 128
}
},
"truncated": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"framework",
"version",
"package",
"tags"
]
}
},
"conflicts": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"framework",
"version",
"package",
"tags"
]
}
}
},
"required": [
"audience"
],
"additionalProperties": false
},
"lastModified": {
"type": "string",
"maxLength": 256
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
}
},
"required": [
"canonicalUrl",
"scope",
"digest",
"indexGeneration"
],
"additionalProperties": false
},
"score": {
"type": "number"
},
"content": {
"type": "string"
},
"chars": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"utf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"truncated": {
"type": "boolean"
}
},
"required": [
"id",
"title",
"pageUrl",
"url",
"content",
"chars",
"utf8Bytes",
"truncated"
],
"additionalProperties": false
}
}
},
"required": [
"query",
"filters",
"budget",
"resultCount",
"candidateCount",
"context",
"sources"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢get_navigation(locale)
Return the documentation navigation tree for the current docs site.
입력 스키마
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"navigation": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"name",
"children"
],
"additionalProperties": false
},
"markdown": {
"type": "string"
}
},
"required": [
"navigation",
"markdown"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$defs": {
"__schema0": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "page"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "folder"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"index": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "page"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"icon": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"additionalProperties": false
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"type",
"name",
"children"
],
"additionalProperties": false
}
]
}
}
}🟢hydrate_content_changes(since, tokenBudget, cursor, locale)
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.
입력 스키마
{
"type": "object",
"properties": {
"since": {
"type": "string"
},
"tokenBudget": {
"default": 5000,
"type": "integer",
"minimum": 4,
"maximum": 32000
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Opaque nextCursor from the preceding response page."
},
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"since"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"format": {
"type": "string",
"const": "docs-content-change-hydration.v1"
},
"audience": {
"type": "string",
"const": "agent"
},
"locale": {
"type": "string"
},
"since": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"mode": {
"type": "string",
"enum": [
"snapshot",
"delta",
"reset"
]
},
"resetRequired": {
"type": "boolean"
},
"documentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"counts": {
"type": "object",
"properties": {
"added": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"changed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"deleted": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"added",
"changed",
"deleted"
],
"additionalProperties": false
},
"budget": {
"type": "object",
"properties": {
"requestedTokens": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"strategy": {
"type": "string",
"const": "utf8-bytes"
},
"maxUtf8Bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"usedUtf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"conservativeTokenUpperBound": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"remainingUtf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"requestedTokens",
"strategy",
"maxUtf8Bytes",
"usedUtf8Bytes",
"conservativeTokenUpperBound",
"remainingUtf8Bytes"
],
"additionalProperties": false
},
"resultCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Items returned in this response page."
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"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."
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"lastModified": {
"type": "string"
},
"type": {
"type": "string",
"const": "content"
},
"change": {
"type": "string",
"enum": [
"added",
"changed"
]
},
"previousDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"previousLastModified": {
"type": "string"
},
"section": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"level": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"heading",
"level"
],
"additionalProperties": false
},
"sectionDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"chunkDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"chunk": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"count": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"index",
"count"
],
"additionalProperties": false
},
"content": {
"type": "string"
},
"utf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"url",
"canonicalUrl",
"digest",
"type",
"change",
"section",
"sectionDigest",
"chunkDigest",
"chunk",
"content",
"utf8Bytes"
],
"additionalProperties": false
}
},
"tombstones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"lastModified": {
"type": "string"
},
"type": {
"type": "string",
"const": "tombstone"
},
"change": {
"type": "string",
"const": "deleted"
}
},
"required": [
"url",
"canonicalUrl",
"digest",
"type",
"change"
],
"additionalProperties": false
}
}
},
"required": [
"format",
"audience",
"since",
"indexGeneration",
"mode",
"resetRequired",
"documentCount",
"counts",
"budget",
"resultCount",
"total",
"hasMore",
"content",
"tombstones"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_content_changes(since, locale)
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.
입력 스키마
{
"type": "object",
"properties": {
"since": {
"type": "string"
},
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"format": {
"type": "string",
"const": "docs-content-changes.v1"
},
"audience": {
"type": "string",
"enum": [
"human",
"agent"
]
},
"locale": {
"type": "string"
},
"since": {
"anyOf": [
{
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
{
"type": "null"
}
]
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"mode": {
"type": "string",
"enum": [
"snapshot",
"delta",
"reset"
]
},
"resetRequired": {
"type": "boolean"
},
"documentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"counts": {
"type": "object",
"properties": {
"added": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"changed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"deleted": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"added",
"changed",
"deleted"
],
"additionalProperties": false
},
"added": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"lastModified": {
"type": "string"
}
},
"required": [
"url",
"canonicalUrl",
"digest"
],
"additionalProperties": false
}
},
"changed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"lastModified": {
"type": "string"
},
"previousDigest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"previousLastModified": {
"type": "string"
}
},
"required": [
"url",
"canonicalUrl",
"digest",
"previousDigest"
],
"additionalProperties": false
}
},
"deleted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"canonicalUrl": {
"type": "string",
"maxLength": 4096
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"lastModified": {
"type": "string"
}
},
"required": [
"url",
"canonicalUrl",
"digest"
],
"additionalProperties": false
}
}
},
"required": [
"format",
"audience",
"since",
"indexGeneration",
"mode",
"resetRequired",
"documentCount",
"counts",
"added",
"changed",
"deleted"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_docs(section, locale, cursor)
List documentation pages grouped by section, optionally narrowed to one section.
입력 스키마
{
"type": "object",
"properties": {
"section": {
"type": "string",
"minLength": 1
},
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Opaque nextCursor from the preceding response page."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"resultCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Items returned in this response page."
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"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."
},
"section": {
"type": "string"
},
"sectionCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"page",
"api",
"code",
"changelog"
]
},
"description": {
"type": "string"
},
"agent": {
"type": "object",
"properties": {
"hasContract": {
"type": "boolean"
},
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"framework": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"package": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"required": [
"hasContract"
],
"additionalProperties": false
},
"icon": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"required": [
"slug",
"url",
"title"
],
"additionalProperties": false
}
},
"rootPages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"page",
"api",
"code",
"changelog"
]
},
"description": {
"type": "string"
},
"agent": {
"type": "object",
"properties": {
"hasContract": {
"type": "boolean"
},
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"framework": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"package": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"required": [
"hasContract"
],
"additionalProperties": false
},
"icon": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"required": [
"slug",
"url",
"title"
],
"additionalProperties": false
}
},
"sections": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"resultCount",
"total",
"hasMore",
"sectionCount",
"pages",
"rootPages",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"pageCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"page",
"api",
"code",
"changelog"
]
},
"description": {
"type": "string"
},
"agent": {
"type": "object",
"properties": {
"hasContract": {
"type": "boolean"
},
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"framework": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"package": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"required": [
"hasContract"
],
"additionalProperties": false
},
"icon": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"required": [
"slug",
"url",
"title"
],
"additionalProperties": false
}
},
"sections": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"slug",
"title",
"pageCount",
"pages",
"sections"
],
"additionalProperties": false
}
}
}🟢list_page_sections(path, locale, tokenBudget, byteBudget, cursor)
Discover a page's canonical headings, anchors, hierarchy, line ranges, size estimates, and budget-aware fetch URLs without returning the page body.
입력 스키마
{
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1
},
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"tokenBudget": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"byteBudget": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Opaque nextCursor from the preceding response page."
}
},
"required": [
"path"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"schemaVersion": {
"type": "number",
"const": 2
},
"format": {
"type": "string",
"const": "docs-markdown-sections.v2"
},
"canonicalUrl": {
"type": "string"
},
"markdownUrl": {
"type": "string"
},
"sectionIndexUrl": {
"type": "string"
},
"lineNumbering": {
"type": "string",
"const": "body"
},
"sectionCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"resultCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Items returned in this response page."
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"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."
},
"estimatedTokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"utf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fetchBudget": {
"type": "object",
"properties": {
"tokenBudget": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"byteBudget": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"level": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"parentId": {
"type": "string"
},
"startLine": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"endLine": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"estimatedTokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"utf8Bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"canonicalUrl": {
"type": "string"
},
"markdownUrl": {
"type": "string"
}
},
"required": [
"id",
"heading",
"level",
"startLine",
"endLine",
"estimatedTokens",
"utf8Bytes",
"canonicalUrl",
"markdownUrl"
],
"additionalProperties": false
}
}
},
"required": [
"schemaVersion",
"format",
"canonicalUrl",
"markdownUrl",
"sectionIndexUrl",
"lineNumbering",
"sectionCount",
"resultCount",
"total",
"hasMore",
"estimatedTokens",
"utf8Bytes",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_pages(locale, cursor)
List the known documentation pages with titles, slugs, and URLs.
입력 스키마
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Opaque nextCursor from the preceding response page."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"resultCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Items returned in this response page."
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"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."
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"page",
"api",
"code",
"changelog"
]
},
"description": {
"type": "string"
},
"agent": {
"type": "object",
"properties": {
"hasContract": {
"type": "boolean"
},
"task": {
"type": "string"
},
"outcome": {
"type": "string"
},
"appliesTo": {
"type": "object",
"properties": {
"framework": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"package": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"required": [
"hasContract"
],
"additionalProperties": false
},
"icon": {
"type": "string"
},
"sourcePath": {
"type": "string"
},
"lastModified": {
"type": "string"
}
},
"required": [
"slug",
"url",
"title"
],
"additionalProperties": false
}
}
},
"required": [
"resultCount",
"total",
"hasMore",
"pages"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_search_facets(locale, audience, facet, limit, cursor, ...)
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.
입력 스키마
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"audience": {
"type": "string",
"enum": [
"human",
"agent"
]
},
"facet": {
"type": "string",
"enum": [
"framework",
"version",
"package",
"tags"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Opaque nextCursor from the preceding response page."
},
"framework": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 128
},
{
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
]
},
"version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 128
},
{
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
]
},
"package": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 128
},
{
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
]
},
"tags": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 128
},
{
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}출력 스키마
{
"type": "object",
"properties": {
"format": {
"type": "string",
"const": "docs-search-facets.v1"
},
"audience": {
"type": "string",
"enum": [
"human",
"agent"
]
},
"filters": {
"type": "object",
"properties": {
"framework": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "array",
"items": {
"type": "string"
}
},
"package": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"indexGeneration": {
"type": "string",
"pattern": "^sha256:[a-f\\d]{64}$"
},
"matchedPageCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"facets": {
"type": "object",
"properties": {
"framework": {
"type": "object",
"properties": {
"valueCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"hasMore": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"truncated": {
"type": "boolean"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"value",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"additionalProperties": false
},
"version": {
"type": "object",
"properties": {
"valueCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"hasMore": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"truncated": {
"type": "boolean"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"value",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"additionalProperties": false
},
"package": {
"type": "object",
"properties": {
"valueCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"hasMore": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"truncated": {
"type": "boolean"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"value",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"additionalProperties": false
},
"tags": {
"type": "object",
"properties": {
"valueCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"hasMore": {
"type": "boolean"
},
"nextCursor": {
"type": "string"
},
"truncated": {
"type": "boolean"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"value",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"valueCount",
"total",
"hasMore",
"truncated",
"values"
],
"additionalProperties": false
}
},
"required": [
"framework",
"version",
"package",
"tags"
],
"additionalProperties": false
}
},
"required": [
"format",
"audience",
"filters",
"indexGeneration",
"matchedPageCount",
"facets"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}커뮤니티
증거
최근 관측
검증됨버전이 기록되지 않음도구 10개