economicIndicators_cpi
Retrieve US Consumer Price Index (CPI) data to analyze inflation trends. Access monthly or semiannual data in JSON or CSV format for economic analysis.
Instructions
Retrieves US Consumer Price Index (CPI) data.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| interval | No | Time interval. | monthly |
| datatype | No | Data format for the response. | json |
Implementation Reference
- src/index.ts:615-626 (registration)Registers the 'economicIndicators_cpi' MCP tool, defining its name, description, input schema, and execution handler that delegates to the Alpha Vantage library via executeAvantageTool.server.addTool({ name: "economicIndicators_cpi", description: "Retrieves US Consumer Price Index (CPI) data.", parameters: schemas.EconomicIndicatorsCPIParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool("economicIndicators_cpi", args, context, (av, params) => av.economicIndicators.cpi(params) ), });
- src/schemas.ts:139-142 (schema)Zod schema defining the input parameters for the economicIndicators_cpi tool (interval: monthly|semiannual, datatype: json|csv).export const EconomicIndicatorsCPIParamsSchema = z.object({ interval: z.enum(['monthly', 'semiannual']).default('monthly').optional().describe('Time interval.'), datatype: DatatypeSchema.default('json').optional(), }).describe('Parameters for fetching CPI data.')
- src/index.ts:38-115 (helper)Generic helper function used by all tools, including economicIndicators_cpi, to manage AVantage client lifecycle, execute the specific library method (e.g., av.economicIndicators.cpi), and return JSON 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}` ); } }