get_data_coverage
Read-onlyIdempotent
Retrieve data coverage metrics for supported venue APIs. Returns earliest and latest timestamps, total records, symbol count, resolution, lag, and completeness per data type and venue scope.
Instructions
Get data coverage across supported venue APIs. Returns earliest/latest timestamps, total records, symbol count, resolution, lag, and completeness per data type per venue scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Result data object |
Implementation Reference
- src/index.ts:1938-1948 (registration)Registration of the 'get_data_coverage' tool using the registerTool helper. The handler calls api().dataQuality.coverage() and returns the result via formatResponse.
// 30. Coverage Overview registerTool( "get_data_coverage", "Get data coverage across supported venue APIs. Returns earliest/latest timestamps, total records, symbol count, resolution, lag, and completeness per data type per venue scope.", {}, ObjectOutputSchema, async () => { const data = await api().dataQuality.coverage(); return formatResponse(data); } ); - src/index.ts:1944-1947 (handler)The actual handler function for get_data_coverage: an async arrow function that calls api().dataQuality.coverage() and passes the result to formatResponse.
async () => { const data = await api().dataQuality.coverage(); return formatResponse(data); } - src/index.ts:1939-1943 (schema)Input schema (empty object {}) and output schema (ObjectOutputSchema) for the get_data_coverage tool. The tool takes no parameters and returns a 'data' object.
registerTool( "get_data_coverage", "Get data coverage across supported venue APIs. Returns earliest/latest timestamps, total records, symbol count, resolution, lag, and completeness per data type per venue scope.", {}, ObjectOutputSchema, - src/index.ts:328-358 (helper)The registerTool helper function used to register get_data_coverage. It wraps the handler with API key guard and error handling, then calls server.registerTool.
function registerTool( name: string, description: string, inputSchema: ZodRawShape, outputSchema: ZodRawShape, handler: (params: any) => Promise<McpContent> ): void { server.registerTool( name, { description, inputSchema, outputSchema, annotations: TOOL_ANNOTATIONS, }, async (params: any) => { if (!client) { return { content: [{ type: "text" as const, text: MISSING_KEY_MESSAGE }], isError: true, }; } try { return await handler(params); } catch (err) { const error = err instanceof OxArchiveError ? err : new OxArchiveError(String(err), 500); return formatError(error); } } ); }