{ "openapi": "3.1.0", "info": { "title": "@p4n/erc8004-ui documentation API", "summary": "Read-only JSON documentation API for the ERC-8004 UI component library.", "description": "Drop-in React components for displaying verified ERC-8004 AI agent identity, reputation, and validation data. Self-contained, trustless, and designed to be consumed by AI coding agents.\n\nThis API serves the library's own documentation — components, props, usage\nexamples, setup guides and supported chains — as JSON, so an agent can read\nthe reference without scraping HTML. It is generated from the same registry\nthat produces the documentation site, llms.txt and the MCP server, so all\nfour describe the same library.\n\nNo authentication. No API keys. CORS is open to every origin. Responses are\ncacheable for five minutes and only change when the site is redeployed.\n\nA fair-use quota of 300 requests per 60 seconds per client applies, enforced\nper function instance. Every response — success or failure — carries the\n`RateLimit` and `RateLimit-Policy` structured fields, plus the older\n`RateLimit-Limit` / `-Remaining` / `-Reset` triple, so a client can pace\nitself rather than discover the limit by being refused. A 429 adds\n`Retry-After`. If you need the whole reference in bulk and would rather not\nthink about any of this, fetch /llms-full.txt once instead.\n\nIt does **not** proxy on-chain data: the components query The Graph directly\nfrom the browser with the consuming application's own Graph API key. To check\nlive subgraph or agent state, use the MCP server's live tools instead.", "version": "1.1.0", "license": { "name": "MIT", "identifier": "MIT" }, "contact": { "name": "Issues and questions", "url": "https://github.com/p4nthera115/erc8004-ui/issues" } }, "servers": [ { "url": "https://erc8004-ui.vercel.app", "description": "Production" } ], "externalDocs": { "description": "Human documentation", "url": "https://erc8004-ui.vercel.app/docs/introduction" }, "tags": [ { "name": "discovery", "description": "Find out what this API offers." }, { "name": "components", "description": "The component reference." }, { "name": "guides", "description": "Setup and concept guides." }, { "name": "reference", "description": "Types and chain support." }, { "name": "mcp", "description": "Model Context Protocol endpoint and its discovery manifest." } ], "paths": { "/api": { "get": { "tags": [ "discovery" ], "operationId": "getApiIndex", "summary": "API index", "description": "Every endpoint, the OpenAPI document, and the non-API entry points (llms.txt, agents.md, the MCP endpoint). Start here.", "responses": { "200": { "description": "The endpoint index.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiIndex" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/health": { "get": { "tags": [ "discovery" ], "operationId": "getHealth", "summary": "Health and build stamp", "description": "Liveness plus the documentation snapshot's timestamp, so a caller can tell whether a redeploy has picked up a docs change.", "responses": { "200": { "description": "Service is up.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/components": { "get": { "tags": [ "components" ], "operationId": "listComponents", "summary": "List components", "parameters": [ { "name": "group", "in": "query", "required": false, "description": "Restrict to one registry group.", "schema": { "type": "string", "enum": [ "Providers", "Identity", "Reputation", "Validation", "Activity" ] } }, { "name": "q", "in": "query", "required": false, "description": "Free-text search across component names, slugs, props and documentation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Matching components.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentList" } } } }, "400": { "description": "Unknown `group`. `error.allowed` lists the valid groups.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/components/{slug}": { "get": { "tags": [ "components" ], "operationId": "getComponent", "summary": "Get one component", "description": "Full documentation: description, caveats, import line, usage, worked examples, props table and state handling. Accepts either the slug (`reputation-score`) or the component name (`ReputationScore`).", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Component slug or name.", "schema": { "type": "string", "examples": [ "erc8004-provider", "agent-provider", "fingerprint-badge" ] } }, { "name": "format", "in": "query", "required": false, "description": "Response format. Defaults to `json`, or to `markdown` when the request's Accept header asks for text/markdown.", "schema": { "type": "string", "enum": [ "json", "markdown" ] } } ], "responses": { "200": { "description": "The component, as JSON or as markdown.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Component" } }, "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Unknown `format`.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/guides": { "get": { "tags": [ "guides" ], "operationId": "listGuides", "summary": "List guides", "responses": { "200": { "description": "Guides in reading order.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuideList" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/guides/{slug}": { "get": { "tags": [ "guides" ], "operationId": "getGuide", "summary": "Get one guide", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "introduction", "installation", "concepts", "api-keys", "components", "accessibility", "theming", "mcp" ] } }, { "name": "format", "in": "query", "required": false, "description": "Response format. Defaults to `json`, or to `markdown` when the request's Accept header asks for text/markdown.", "schema": { "type": "string", "enum": [ "json", "markdown" ] } } ], "responses": { "200": { "description": "The guide, as JSON or as markdown.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Guide" } }, "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Unknown `format`.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/chains": { "get": { "tags": [ "reference" ], "operationId": "listChains", "summary": "Supported chains", "description": "Chains with a deployed subgraph this library can query, and the subgraph id used for each.", "responses": { "200": { "description": "Supported chains.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChainList" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/types": { "get": { "tags": [ "reference" ], "operationId": "getTypes", "summary": "TypeScript type definitions", "description": "`packages/ui/src/types.ts` verbatim — the public data model.", "parameters": [ { "name": "format", "in": "query", "required": false, "description": "Response format. Defaults to `json`, or to `markdown` when the request's Accept header asks for text/markdown.", "schema": { "type": "string", "enum": [ "json", "markdown" ] } } ], "responses": { "200": { "description": "The type definitions.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Types" } }, "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Unknown `format`.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/mcp": { "post": { "tags": [ "mcp" ], "operationId": "callMcp", "summary": "Model Context Protocol endpoint", "description": "Streamable HTTP transport. Stateless: no sessions are minted, no SSE\nstreams are opened, and each JSON-RPC message is its own POST.\n\nDual-era. Modern clients (protocol 2026-07-28 and later) send their\nversion in `params._meta` mirrored into the MCP-Protocol-Version,\nMcp-Method and Mcp-Name headers, and may call the mandatory\n`server/discover`. Clients on 2025-11-25 and earlier use the\n`initialize` handshake instead.\n\nExposes the four documentation tools: list_components, get_component,\nget_setup_guide, get_types. The live subgraph tools are stdio-only —\nthey spend a Graph API key, which a public endpoint should not do with\nsomeone else's quota.", "parameters": [ { "name": "MCP-Protocol-Version", "in": "header", "required": false, "description": "Required for protocol 2026-07-28 and later; must match the version in the body's `params._meta`.", "schema": { "type": "string", "examples": [ "2026-07-28" ] } }, { "name": "Mcp-Method", "in": "header", "required": false, "description": "Required for protocol 2026-07-28 and later; must match the body's `method`.", "schema": { "type": "string", "examples": [ "tools/list" ] } }, { "name": "Mcp-Name", "in": "header", "required": false, "description": "Required for `tools/call` on protocol 2026-07-28 and later; must match `params.name`.", "schema": { "type": "string", "examples": [ "get_component" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcRequest" } } } }, "responses": { "200": { "description": "JSON-RPC response.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "202": { "description": "Notification accepted. No body.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "description": "Malformed message, header mismatch (-32020) or unsupported protocol version (-32022).", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "403": { "description": "Invalid Origin header.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "404": { "description": "Unimplemented JSON-RPC method (-32601), for modern protocol versions.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "405": { "description": "GET and DELETE are not supported: this endpoint is stateless and offers no standalone stream.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "429": { "description": "Over the fair-use quota, as a JSON-RPC error (-32000) rather than the REST envelope — this endpoint's clients read JSON-RPC.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } } } } }, "/.well-known/mcp": { "get": { "tags": [ "mcp" ], "operationId": "getMcpManifest", "summary": "MCP discovery manifest", "description": "Transport, supported protocol versions, capabilities and tool list for the MCP endpoint, plus the stdio package that adds the live tools.", "responses": { "200": { "description": "The manifest.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpManifest" } } } }, "404": { "description": "No such resource. `error.allowed` lists valid values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not supported by this endpoint.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header rules out every media type this endpoint can produce. `error.allowed` lists what it can. Omitting Accept, or sending `*/*`, is never rejected.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Over the fair-use quota. `Retry-After` and `RateLimit-Reset` both give the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unhandled server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "headers": { "RateLimit": { "description": "This caller's position in the quota window, as the structured field from draft-ietf-httpapi-ratelimit-headers: the policy name, `r` remaining requests, `t` seconds until the window resets.", "schema": { "type": "string", "examples": [ "\"default\";r=299;t=60" ] } }, "RateLimitPolicy": { "description": "The quota policy itself: `q` requests per `w` seconds. Enforced per function instance, so the effective ceiling is at least this.", "schema": { "type": "string", "examples": [ "\"default\";q=300;w=60" ] } }, "RateLimitLimit": { "description": "Requests allowed in the current window. The earlier spelling of the `q` parameter of RateLimit-Policy, emitted for clients that only understand the original draft.", "schema": { "type": "integer", "examples": [ 300 ] } }, "RateLimitRemaining": { "description": "Requests left in the current window.", "schema": { "type": "integer", "examples": [ 299 ] } }, "RateLimitReset": { "description": "Seconds until the current window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "RetryAfter": { "description": "Seconds to wait before retrying. Only on a 429.", "schema": { "type": "integer", "examples": [ 42 ] } } }, "schemas": { "Error": { "type": "object", "description": "Every failure this API produces, in one shape. `code` is stable and safe to branch on; `hint` says what to do next.", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "status", "message", "hint" ], "properties": { "code": { "type": "string", "enum": [ "not_found", "invalid_parameter", "method_not_allowed", "not_acceptable", "unsupported_media_type", "rate_limited", "internal_error" ] }, "status": { "type": "integer", "examples": [ 404 ] }, "message": { "type": "string" }, "hint": { "type": "string", "description": "The corrective action, not a restatement of the error." }, "allowed": { "type": "array", "items": { "type": "string" }, "description": "Valid values, when the failure was an unknown identifier." }, "documentation": { "type": "string", "format": "uri" }, "specification": { "type": "string", "format": "uri" } } } } }, "PropDef": { "type": "object", "required": [ "name", "type", "required", "description" ], "properties": { "name": { "type": "string" }, "type": { "type": "string", "description": "TypeScript type, verbatim." }, "required": { "type": "boolean" }, "default": { "type": "string" }, "description": { "type": "string" } } }, "Note": { "type": "object", "required": [ "variant", "body" ], "properties": { "variant": { "type": "string", "enum": [ "info", "warning" ] }, "title": { "type": "string" }, "body": { "type": "string" } } }, "Example": { "type": "object", "required": [ "name", "code" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "code": { "type": "string" } } }, "ComponentSummary": { "type": "object", "required": [ "slug", "name", "group", "description" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "group": { "type": "string", "enum": [ "Providers", "Identity", "Reputation", "Validation", "Activity" ] }, "description": { "type": "string" }, "importLine": { "type": "string" }, "requiredProps": { "type": "array", "items": { "type": "string" } }, "docsUrl": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "apiUrl": { "type": "string", "format": "uri" } } }, "Component": { "type": "object", "required": [ "slug", "name", "group", "description", "props", "markdown" ], "properties": { "slug": { "type": "string", "enum": [ "erc8004-provider", "agent-provider", "fingerprint-badge", "agent-name", "agent-image", "agent-description", "agent-card", "endpoint-status", "reputation-score", "reputation-timeline", "reputation-distribution", "feedback-list", "tag-cloud", "verification-badge", "validation-score", "validation-list", "validation-display", "last-activity", "activity-log" ] }, "name": { "type": "string" }, "group": { "type": "string", "enum": [ "Providers", "Identity", "Reputation", "Validation", "Activity" ] }, "description": { "type": "string" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "importLine": { "type": "string" }, "usage": { "type": "string" }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/Example" } }, "inContext": { "type": [ "object", "null" ], "properties": { "description": { "type": "string" }, "code": { "type": "string" } } }, "states": { "type": [ "string", "null" ], "description": "How the component renders loading, error and empty states." }, "props": { "type": "array", "items": { "$ref": "#/components/schemas/PropDef" } }, "docsUrl": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "markdown": { "type": "string", "description": "The whole component page as markdown — identical to what `?format=markdown` and the site's `.md` URL return." }, "packageName": { "type": "string" }, "nonAffiliationNotice": { "type": "string" } } }, "ComponentList": { "type": "object", "required": [ "count", "total", "components" ], "properties": { "count": { "type": "integer" }, "total": { "type": "integer" }, "filters": { "type": "object", "properties": { "group": { "type": [ "string", "null" ] }, "q": { "type": [ "string", "null" ] } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "slugs": { "type": "array", "items": { "type": "string" } } } } }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentSummary" } } } }, "Guide": { "type": "object", "required": [ "slug", "name", "description", "markdown" ], "properties": { "slug": { "type": "string", "enum": [ "introduction", "installation", "concepts", "api-keys", "components", "accessibility", "theming", "mcp" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "docsUrl": { "type": "string", "format": "uri" }, "markdown": { "type": "string" } } }, "GuideList": { "type": "object", "required": [ "count", "guides" ], "properties": { "count": { "type": "integer" }, "guides": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "docsUrl": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "apiUrl": { "type": "string", "format": "uri" } } } } } }, "Chain": { "type": "object", "required": [ "chainId", "name", "testnet", "subgraphId" ], "properties": { "chainId": { "type": "integer", "examples": [ 8453 ] }, "name": { "type": "string", "examples": [ "Base" ] }, "testnet": { "type": "boolean" }, "subgraphId": { "type": "string" }, "agentRegistryFormat": { "type": "string", "description": "The CAIP-style identifier shape components expect for this chain." } } }, "ChainList": { "type": "object", "required": [ "count", "chains" ], "properties": { "count": { "type": "integer" }, "subgraphUrlTemplate": { "type": "string" }, "note": { "type": "string" }, "chains": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" } } } }, "Types": { "type": "object", "required": [ "types" ], "properties": { "packageName": { "type": "string" }, "source": { "type": "string", "examples": [ "packages/ui/src/types.ts" ] }, "language": { "type": "string", "examples": [ "typescript" ] }, "types": { "type": "string" } } }, "ApiIndex": { "type": "object", "required": [ "name", "endpoints" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "version": { "type": "string" }, "documentation": { "type": "string", "format": "uri" }, "specification": { "type": "string", "format": "uri" }, "agentInstructions": { "type": "string", "format": "uri" }, "llmsTxt": { "type": "string", "format": "uri" }, "llmsFullTxt": { "type": "string", "format": "uri" }, "mcp": { "type": "object", "additionalProperties": true }, "rateLimit": { "type": "object", "description": "The fair-use quota, and the header names that report it.", "properties": { "policy": { "type": "string" }, "limit": { "type": "integer" }, "windowSeconds": { "type": "integer" }, "scope": { "type": "string" }, "headers": { "type": "array", "items": { "type": "string" } }, "onExceeded": { "type": "object", "additionalProperties": true }, "note": { "type": "string" } } }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string" }, "path": { "type": "string" }, "description": { "type": "string" } } } }, "counts": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "Health": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "generatedAt": { "type": "string", "format": "date-time" }, "packageName": { "type": "string" }, "counts": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "McpManifest": { "type": "object", "required": [ "name", "protocolVersions", "transport", "tools" ], "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "instructions": { "type": "string" }, "protocolVersions": { "type": "array", "items": { "type": "string" } }, "capabilities": { "type": "object", "additionalProperties": true }, "authentication": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "none" ] } } }, "transport": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http" ] }, "url": { "type": "string", "format": "uri" } } }, "remotes": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "packages": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "tools": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" } } } } } }, "JsonRpcRequest": { "type": "object", "required": [ "jsonrpc", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": [ "string", "integer", "null" ] }, "method": { "type": "string", "enum": [ "server/discover", "initialize", "ping", "tools/list", "tools/call" ] }, "params": { "type": "object", "additionalProperties": true } } }, "JsonRpcResponse": { "type": "object", "required": [ "jsonrpc" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": [ "string", "integer", "null" ] }, "result": { "type": "object", "additionalProperties": true }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": true } } } } } } } }