fundamentalData_companyOverview
Retrieve comprehensive company overview details, including stock symbol for insights into financial data, using the Alpha Vantage API on the MCP Avantage server.
Instructions
Fetches company overview details. Premium endpoint.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | The stock symbol (e.g., "IBM"). |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"description": "Parameter schema requiring only a stock symbol.",
"properties": {
"symbol": {
"description": "The stock symbol (e.g., \"IBM\").",
"type": "string"
}
},
"required": [
"symbol"
],
"type": "object"
}
Implementation Reference
- src/index.ts:776-790 (registration)Registers the MCP tool 'fundamentalData_companyOverview' on the FastMCP server. Specifies the tool name, description, input parameters schema, and the execute handler function that delegates to the generic executeAvantageTool with the specific Alpha Vantage library method call.server.addTool({ name: "fundamentalData_companyOverview", description: "Fetches company overview details. Premium endpoint.", parameters: schemas.FundamentalDataSymbolParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "fundamentalData_companyOverview", args, context, (av, params) => av.fundamentalData.companyOverview(params.symbol) ), });
- src/schemas.ts:172-175 (schema)Zod schema definition for the tool's input parameters, requiring a single 'symbol' string (e.g., stock ticker like 'IBM'). Used for input validation in the tool registration.export const FundamentalDataSymbolParamsSchema = z.object({ symbol: z.string().describe('The stock symbol (e.g., "IBM").'), }).describe('Parameter schema requiring only a stock symbol.')
- src/index.ts:780-789 (handler)The handler function provided to MCP server.addTool for executing the tool logic. It calls the generic executeAvantageTool, passing the tool name, validated args, context, and a callback that invokes the specific AVantage library method: av.fundamentalData.companyOverview(params.symbol).execute: ( args, context // Let type be inferred ) => executeAvantageTool( "fundamentalData_companyOverview", args, context, (av, params) => av.fundamentalData.companyOverview(params.symbol) ),
- src/index.ts:38-115 (helper)Shared helper function used by all tools (including this one) to execute Alpha Vantage API calls. Manages authentication, AVantage instance lifecycle via resourceManager, invokes the library method, handles responses/errors, and returns stringified JSON data or throws UserError.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}` ); } }