fundamentalData_earningsCalendar
Fetch upcoming earnings calendar data for stocks to track corporate financial announcements. Specify symbols and time horizons for earnings reports.
Instructions
Fetches upcoming earnings calendar (CSV endpoint).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | No | Fetch earnings calendar for a specific symbol. | |
| horizon | No | Time horizon for upcoming earnings. | 3month |
Implementation Reference
- src/index.ts:38-115 (handler)Generic handler function that implements the core logic for executing the tool: resolves API key, manages AVantage client instance via resourceManager, calls the specific AVantage library method (av.fundamentalData.earningsCalendar(params) for this tool), 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/schemas.ts:182-185 (schema)Zod schema defining the input parameters for the fundamentalData_earningsCalendar tool.export const FundamentalDataEarningsCalendarParamsSchema = z.object({ symbol: z.string().optional().describe('Fetch earnings calendar for a specific symbol.'), horizon: z.enum(['3month', '6month', '12month']).default('3month').optional().describe('Time horizon for upcoming earnings.'), }).describe('Parameters for fetching earnings calendar (CSV endpoint).')
- src/index.ts:919-933 (registration)Registers the MCP tool 'fundamentalData_earningsCalendar' with the FastMCP server, linking name, description, input schema, and handler execution.server.addTool({ name: "fundamentalData_earningsCalendar", description: "Fetches upcoming earnings calendar (CSV endpoint).", parameters: schemas.FundamentalDataEarningsCalendarParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "fundamentalData_earningsCalendar", args, context, (av, params) => av.fundamentalData.earningsCalendar(params) ), });
- src/index.ts:64-80 (helper)Uses resourceManager to get or create the AVantage API client instance, cached by API key, which is central to all tool executions including this one.// 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)`); } );