economicIndicators_federalFundsRate
Retrieve the effective federal funds rate data in JSON or CSV format for daily, weekly, or monthly intervals to analyze monetary policy and economic conditions.
Instructions
Retrieves the effective federal funds rate.
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:599-613 (handler)MCP server tool registration including the inline execute handler function for 'economicIndicators_federalFundsRate'. The handler delegates execution to the generic executeAvantageTool helper, which calls the Alpha Vantage SDK method av.economicIndicators.federalFundsRate(params).server.addTool({ name: "economicIndicators_federalFundsRate", description: "Retrieves the effective federal funds rate.", parameters: schemas.EconomicIndicatorsFederalFundsRateParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "economicIndicators_federalFundsRate", args, context, (av, params) => av.economicIndicators.federalFundsRate(params) ), });
- src/schemas.ts:134-137 (schema)Zod schema defining the input parameters (interval and datatype) for the economicIndicators_federalFundsRate tool.export const EconomicIndicatorsFederalFundsRateParamsSchema = z.object({ interval: DailyWeeklyMonthlySchema.default('monthly').optional(), datatype: DatatypeSchema.default('json').optional(), }).describe('Parameters for fetching Federal Funds Rate data.')
- src/index.ts:38-115 (helper)Generic helper function shared across all MCP tools. Manages Alpha Vantage client lifecycle via resourceManager, resolves API key, invokes the tool-specific SDK method, 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}` ); } }