get_endpoint_docs
Retrieve documentation for specific blockchain endpoints to understand available data access points and their usage across multiple networks.
Instructions
Get documentation for a specific endpoint
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endpointId | Yes | The ID of the endpoint |
Implementation Reference
- src/handlers/docs-handlers.ts:107-131 (handler)Handler logic for the 'get_endpoint_docs' tool: extracts the endpointId argument, retrieves the documentation using docsManager, and returns the result as MCP-formatted content or an error.case 'get_endpoint_docs': { const endpointId = args?.endpointId as string; const docPage = await docsManager.getEndpointDocs(endpointId); if (!docPage) { return { content: [ { type: 'text', text: `Documentation not found for endpoint: ${endpointId}`, }, ], isError: true, }; } return { content: [ { type: 'text', text: JSON.stringify(docPage, null, 2), }, ], }; }
- src/handlers/docs-handlers.ts:29-42 (registration)Tool registration definition for 'get_endpoint_docs', including name, description, and input schema, returned by registerDocsHandlers for inclusion in the server's tool list.{ name: 'get_endpoint_docs', description: 'Get documentation for a specific endpoint', inputSchema: { type: 'object', properties: { endpointId: { type: 'string', description: 'The ID of the endpoint', }, }, required: ['endpointId'], }, },
- src/handlers/docs-handlers.ts:32-41 (schema)JSON schema defining the input parameters for the 'get_endpoint_docs' tool: requires 'endpointId' as a string.inputSchema: { type: 'object', properties: { endpointId: { type: 'string', description: 'The ID of the endpoint', }, }, required: ['endpointId'], },
- src/services/docs-manager.ts:59-62 (helper)Supporting method in DocsManager that implements the core logic by fetching the documentation page at the conventional endpoint path /endpoints/{endpointId}.async getEndpointDocs(endpointId: string): Promise<DocPage | null> { // Convention: endpoint docs are at /endpoints/{endpointId} return this.getDocPage(`/endpoints/${endpointId}`); }