optionsData_realtimeOptions
Fetch real-time options chain data for specific stock symbols, including detailed contract information, in JSON or CSV format using MCP Avantage's premium endpoint.
Instructions
Fetches realtime options chain data. Premium endpoint.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| contract | No | Specific option contract ID to fetch details for. | |
| datatype | No | Data format for the response. | json |
| symbol | Yes | The underlying stock symbol (e.g., "AAPL"). |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"description": "Parameters for fetching realtime options chain data (Premium).",
"properties": {
"contract": {
"description": "Specific option contract ID to fetch details for.",
"type": "string"
},
"datatype": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json",
"csv"
],
"type": "string"
},
"symbol": {
"description": "The underlying stock symbol (e.g., \"AAPL\").",
"type": "string"
}
},
"required": [
"symbol"
],
"type": "object"
}
Implementation Reference
- src/index.ts:949-963 (registration)Registration of the 'optionsData_realtimeOptions' MCP tool via server.addTool. Includes name, description, input schema reference, and inline execute handler that wraps executeAvantageTool to call the AVantage library's optionsData.realtimeOptions method.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/schemas.ts:190-194 (schema)Zod schema defining the input parameters for the optionsData_realtimeOptions 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:953-962 (handler)Inline handler function for the tool, which invokes the generic executeAvantageTool helper passing the specific AVantage library method av.optionsData.realtimeOptions.execute: ( args, context // Let type be inferred ) => executeAvantageTool( "optionsData_realtimeOptions", args, context, (av, params) => av.optionsData.realtimeOptions(params) ),
- src/index.ts:38-115 (helper)Generic helper that manages AVantage client lifecycle using resourceManager, authenticates with API key, executes the provided library method, handles errors, and returns JSON-stringified data. Core logic shared across all tools.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}` ); } }