economicIndicators_federalFundsRate
Retrieve the Federal Funds Rate in JSON or CSV format for daily, weekly, or monthly intervals using the MCP Avantage server to analyze key economic trends.
Instructions
Retrieves the effective federal funds rate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datatype | No | Data format for the response. | json |
| interval | No | Time interval. | monthly |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"description": "Parameters for fetching Federal Funds Rate 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"
}
},
"type": "object"
}
Implementation Reference
- src/index.ts:603-613 (handler)The execute handler for the 'economicIndicators_federalFundsRate' tool. It calls the general executeAvantageTool helper, passing a callback that invokes the Alpha Vantage library's economicIndicators.federalFundsRate method.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 for the tool: optional interval (daily/weekly/monthly) and datatype.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:599-613 (registration)Registration of the MCP tool using server.addTool, specifying name, description, parameters schema, and execute handler.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/index.ts:38-115 (helper)Generic helper function used by all tools to execute Alpha Vantage API calls. Manages authentication, AVantage client instantiation via resource manager, invokes the specific library method, and handles responses/errors.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}` ); } }