MCP Avantage

Instructions

Implementation Reference

• src/index.ts:935-946 (registration)

  MCP tool registration for 'fundamentalData_ipoCalendar'. Specifies name, description, empty Zod input schema, and execute handler that wraps Avantage library's fundamentalData.ipoCalendar() call.

  server.addTool({
    name: "fundamentalData_ipoCalendar",
    description: "Fetches upcoming IPO calendar (CSV endpoint).",
    parameters: z.object({}), // No parameters
    execute: (
      args,
      context // Let type be inferred
    ) =>
      executeAvantageTool("fundamentalData_ipoCalendar", args, context, (av) =>
        av.fundamentalData.ipoCalendar()
      ),
  });

• src/index.ts:938-938 (schema)

  Input schema definition: empty object (no parameters required for this tool). Uses Zod directly.

  parameters: z.object({}), // No parameters

• src/index.ts:939-945 (handler)

  Tool execute handler: calls generic executeAvantageTool with the specific Avantage method av.fundamentalData.ipoCalendar() (no args needed). This is the core logic dispatching to the underlying library.

  execute: (
    args,
    context // Let type be inferred
  ) =>
    executeAvantageTool("fundamentalData_ipoCalendar", args, context, (av) =>
      av.fundamentalData.ipoCalendar()
    ),

• src/index.ts:38-115 (helper)

  Generic helper function used by all tools (including this one) for executing Avantage library methods. Manages API key resolution, AVantage instance caching via resourceManager, performs the library call, handles responses/errors, and returns JSON string.

  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}`
      );
    }
  }