economicIndicators_realGDPPerCapita
Access US Real GDP per Capita data in JSON or CSV format to analyze economic trends and inform financial decisions. Powered by MCP Avantage for reliable and comprehensive insights.
Instructions
Retrieves US Real GDP per Capita data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datatype | No | Data format for the response. | json |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"description": "Common parameter schema accepting only datatype.",
"properties": {
"datatype": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json",
"csv"
],
"type": "string"
}
},
"type": "object"
}
Implementation Reference
- src/index.ts:567-581 (registration)Registration of the MCP tool 'economicIndicators_realGDPPerCapita'. Defines the tool name, description, input schema, and execute handler that calls the generic executeAvantageTool with the specific AVantage library method.server.addTool({ name: "economicIndicators_realGDPPerCapita", description: "Retrieves US Real GDP per Capita data.", parameters: schemas.EconomicIndicatorsDataTypeParamSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "economicIndicators_realGDPPerCapita", args, context, (av, params) => av.economicIndicators.realGDPPerCapita(params) ), });
- src/schemas.ts:124-126 (schema)Zod schema for the tool parameters, which only accepts an optional 'datatype' field defaulting to 'json'.export const EconomicIndicatorsDataTypeParamSchema = z.object({ datatype: DatatypeSchema.default('json').optional(), }).describe('Common parameter schema accepting only datatype.')
- src/index.ts:38-115 (handler)Generic handler function shared by all tools. Manages AVantage client instance via resourceManager, authenticates with API key, executes the provided library method (av.economicIndicators.realGDPPerCapita), and returns JSON string of data or throws UserError on failure.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}` ); } }
- src/schemas.ts:6-6 (helper)Shared Zod enum schema for 'datatype' parameter used in EconomicIndicatorsDataTypeParamSchema.const DatatypeSchema = z.enum(['json', 'csv']).describe('Data format for the response.')