economicIndicators_treasuryYield
Access US Treasury yield curve data for specific maturities and intervals using JSON or CSV format to analyze economic indicators efficiently.
Instructions
Retrieves US Treasury yield curve data for various maturities.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datatype | No | Data format for the response. | json |
| interval | No | Time interval. | monthly |
| maturity | No | Treasury maturity period. | 10year |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"description": "Parameters for fetching Treasury Yield data.",
"properties": {
"datatype": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json",
"csv"
],
"type": "string"
},
"interval": {
"default": "monthly",
"description": "Time interval.",
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string"
},
"maturity": {
"default": "10year",
"description": "Treasury maturity period.",
"enum": [
"3month",
"2year",
"5year",
"7year",
"10year",
"30year"
],
"type": "string"
}
},
"type": "object"
}
Implementation Reference
- src/index.ts:583-597 (registration)Registers the 'economicIndicators_treasuryYield' MCP tool with the FastMCP server, including name, description, input schema reference, and execute handler that delegates to the generic executeAvantageTool with the specific Alpha Vantage library method.server.addTool({ name: "economicIndicators_treasuryYield", description: "Retrieves US Treasury yield curve data for various maturities.", parameters: schemas.EconomicIndicatorsTreasuryYieldParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "economicIndicators_treasuryYield", args, context, (av, params) => av.economicIndicators.treasuryYield(params) ), });
- src/schemas.ts:128-132 (schema)Zod schema defining input parameters for the economicIndicators_treasuryYield tool: interval (daily/weekly/monthly), maturity (3month to 30year), and datatype (json/csv).export const EconomicIndicatorsTreasuryYieldParamsSchema = z.object({ interval: DailyWeeklyMonthlySchema.default('monthly').optional(), maturity: z.enum(['3month', '2year', '5year', '7year', '10year', '30year']).default('10year').optional().describe('Treasury maturity period.'), datatype: DatatypeSchema.default('json').optional(), }).describe('Parameters for fetching Treasury Yield data.')
- src/index.ts:38-115 (handler)Generic handler function used by all tools, including economicIndicators_treasuryYield. Manages API key resolution, AVantage client lifecycle via resourceManager, executes the specific library method (av.economicIndicators.treasuryYield), handles errors, and returns JSON stringified data.async function executeAvantageTool<TArgs, TResult>( toolName: string, args: TArgs, context: Context<Record<string, unknown> | undefined>, // Use the imported Context type directly avantageMethod: ( av: AVantage, args: TArgs ) => Promise<{ error?: boolean; reason?: string; data?: TResult }> ): Promise<string> { logger.info(`Executing '${toolName}' tool for request ID: ${context}`); logger.debug(`Args for ${toolName}: ${JSON.stringify(args)}`); // --- Authentication & Resource Management --- // Access extraArgs safely - it might be null or undefined const extraArgsApiKey = context.extraArgs?.apiKey as string | undefined; const apiKey = extraArgsApiKey || config.apiKey; if (!apiKey) { logger.error(`'${toolName}' failed: Alpha Vantage API key missing.`); throw new UserError(apiKeyErrorMessage); } logger.debug( `Using AV API key (source: ${extraArgsApiKey ? "extraArgs" : "environment"}) for ${toolName}` ); try { // Get or create AVantage instance managed by ResourceManager const av = await resourceManager.getResource<AVantage>( apiKey, // Cache key is the resolved API key "avantage_client", // Type identifier for logging async (key) => { // Factory Function logger.info( `Creating new AVantage instance for key ending ...${key.slice(-4)}` ); // AVantage library reads AV_PREMIUM from process.env internally return new AVantage(key); }, async (avInstance) => { // Cleanup Function (no-op needed for AVantage) logger.debug(`Destroying AVantage instance (no-op)`); } ); // --- Library Call --- const result = await avantageMethod(av, args); // --- Response Handling --- if (result.error) { logger.warn( `'${toolName}' failed. Reason from avantage: ${result.reason}` ); throw new UserError(result.reason || `Tool '${toolName}' failed.`); } if (result.data === undefined || result.data === null) { logger.warn(`'${toolName}' completed successfully but returned no data.`); return "null"; // Return string "null" for empty data } logger.info(`'${toolName}' completed successfully.`); // Stringify the data part of the response return JSON.stringify(result.data); } catch (error: any) { logger.error( `Error during execution of '${toolName}': ${error.message}`, error ); // If it's already a UserError, rethrow it if (error instanceof UserError) { throw error; } // Otherwise, wrap it in a UserError throw new UserError( `An unexpected error occurred while executing tool '${toolName}': ${error.message}` ); } }
- src/index.ts:595-596 (helper)Specific callback passed to executeAvantageTool that invokes the Alpha Vantage library's economicIndicators.treasuryYield method with the validated parameters.(av, params) => av.economicIndicators.treasuryYield(params) ),