MCP Avantage

Instructions

Implementation Reference

• src/index.ts:808-822 (handler)

  The handler function (inline execute property) for the 'fundamentalData_dividends' tool. It validates args via schema, resolves API key, creates/manages AVantage client via resourceManager, calls av.fundamentalData.dividends(symbol), and returns JSON data.
  server.addTool({ name: "fundamentalData_dividends", description: "Fetches historical dividend data for a symbol.", parameters: schemas.FundamentalDataSymbolParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "fundamentalData_dividends", args, context, (av, params) => av.fundamentalData.dividends(params.symbol) ), });
• src/schemas.ts:172-175 (schema)

  Zod schema defining the input parameters for the tool: requires a 'symbol' string.
  export const FundamentalDataSymbolParamsSchema = z.object({ symbol: z.string().describe('The stock symbol (e.g., "IBM").'), }).describe('Parameter schema requiring only a stock symbol.')
• src/index.ts:808-822 (registration)

  Registers the 'fundamentalData_dividends' tool with the MCP server using server.addTool.
  server.addTool({ name: "fundamentalData_dividends", description: "Fetches historical dividend data for a symbol.", parameters: schemas.FundamentalDataSymbolParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "fundamentalData_dividends", args, context, (av, params) => av.fundamentalData.dividends(params.symbol) ), });
• src/index.ts:38-115 (helper)

  Shared helper function used by all tools, including this one, to execute Avantage library methods: handles API key, client pooling, API call, error handling, and JSON serialization.
  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}` ); } }