MCP Avantage

Instructions

Implementation Reference

• src/index.ts:949-963 (registration)

  Registers the MCP tool 'optionsData_realtimeOptions' with server.addTool, defining its name, description, input schema, and execute handler function.
  server.addTool({ name: "optionsData_realtimeOptions", description: "Fetches realtime options chain data. Premium endpoint.", parameters: schemas.OptionsDataRealtimeOptionsParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "optionsData_realtimeOptions", args, context, (av, params) => av.optionsData.realtimeOptions(params) ), });
• src/index.ts:961-962 (handler)

  Specific handler logic within the execute function: calls the AVantage library's optionsData.realtimeOptions method with params.
  (av, params) => av.optionsData.realtimeOptions(params) ),
• src/schemas.ts:190-194 (schema)

  Zod schema defining input parameters for the tool: symbol (required), contract (optional), datatype (optional).
  export const OptionsDataRealtimeOptionsParamsSchema = z.object({ symbol: z.string().describe('The underlying stock symbol (e.g., "AAPL").'), contract: z.string().optional().describe('Specific option contract ID to fetch details for.'), datatype: DatatypeSchema.default('json').optional(), }).describe('Parameters for fetching realtime options chain data (Premium).')
• src/index.ts:38-115 (helper)

  Generic helper function used by all tools, including this one: manages Alpha Vantage API key and client instance via resource manager, invokes the specific AVantage 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}` ); } }