fundamentalData_ipoCalendar
Access the upcoming IPO calendar to track new stock listings via CSV data retrieval. Simplify IPO monitoring with precise financial insights from Alpha Vantage API.
Instructions
Fetches upcoming IPO calendar (CSV endpoint).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Input Schema (JSON Schema)
{
"additionalProperties": false,
"properties": {},
"type": "object"
}
Implementation Reference
- src/index.ts:935-946 (registration)Registration of the MCP tool 'fundamentalData_ipoCalendar'. Defines the tool name, description, empty input schema (z.object({})), and execute handler that delegates to the generic executeAvantageTool function, which in turn calls the AVantage library's fundamentalData.ipoCalendar() method.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 for the tool: empty object since no parameters are required.parameters: z.object({}), // No parameters
- src/index.ts:939-945 (handler)The execute handler for the tool, which invokes the shared executeAvantageTool with the specific AVantage method call to ipoCalendar().execute: ( args, context // Let type be inferred ) => executeAvantageTool("fundamentalData_ipoCalendar", args, context, (av) => av.fundamentalData.ipoCalendar() ),
- src/index.ts:38-115 (helper)Shared helper function that performs the actual tool execution: manages AVantage instance via resourceManager, handles API key, calls the library method, processes response, and handles errors.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}` ); } }