MCP Avantage

Instructions

Implementation Reference

• src/index.ts:222-233 (registration)

  Registers the 'commodities_naturalGas' MCP tool, specifying its name, description, input schema, and execute handler that invokes the AVantage library's commodities.naturalGas method via the generic executeAvantageTool wrapper.
  server.addTool({ name: "commodities_naturalGas", description: "Retrieves natural gas prices.", parameters: schemas.CommoditiesDailyWeeklyMonthlyParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool("commodities_naturalGas", args, context, (av, params) => av.commodities.naturalGas(params) ), });
• src/schemas.ts:30-33 (schema)

  Defines the Zod input validation schema for the commodities_naturalGas tool (and similar), supporting optional 'interval' (daily/weekly/monthly) and 'datatype' (json/csv) parameters.
  export const CommoditiesDailyWeeklyMonthlyParamsSchema = z.object({ interval: DailyWeeklyMonthlySchema.optional().describe('Time interval for the data.'), datatype: DatatypeSchema.optional().describe('Response data format.'), }).describe('Parameters for daily/weekly/monthly commodity data.')
• src/index.ts:38-115 (handler)

  Generic handler function used by commodities_naturalGas (and all tools) to manage AVantage client lifecycle, execute the library method av.commodities.naturalGas(params), handle errors, and return JSON 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}` ); } }