commodities_globalIndex
Access global commodity index data in JSON or CSV format, tailored for monthly, quarterly, or annual intervals, using MCP Avantage for financial analysis.
Instructions
Retrieves the global commodity index.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datatype | No | Response data format. | |
| interval | No | Time interval for the data. |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"description": "Parameters for monthly/quarterly/annual commodity data.",
"properties": {
"datatype": {
"description": "Response data format.",
"enum": [
"json",
"csv"
],
"type": "string"
},
"interval": {
"description": "Time interval for the data.",
"enum": [
"monthly",
"quarterly",
"annual"
],
"type": "string"
}
},
"type": "object"
}
Implementation Reference
- src/index.ts:326-340 (registration)Registration of the "commodities_globalIndex" tool using server.addTool. Specifies the tool name, description, input parameters schema, and an execute handler that calls the generic executeAvantageTool function passing a lambda that invokes the AVantage library's commodities.globalIndex method.server.addTool({ name: "commodities_globalIndex", description: "Retrieves the global commodity index.", parameters: schemas.CommoditiesMonthlyQuarterlyAnnualParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "commodities_globalIndex", args, context, (av, params) => av.commodities.globalIndex(params) ), });
- src/schemas.ts:35-38 (schema)Zod schema definition for input parameters of the commodities_globalIndex tool: optional interval (monthly, quarterly, annual) and datatype (json/csv).export const CommoditiesMonthlyQuarterlyAnnualParamsSchema = z.object({ interval: MonthlyQuarterlyAnnualSchema.optional().describe('Time interval for the data.'), datatype: DatatypeSchema.optional().describe('Response data format.'), }).describe('Parameters for monthly/quarterly/annual commodity data.')
- src/index.ts:38-115 (handler)Generic handler function executeAvantageTool used by commodities_globalIndex and all other tools. Manages API key resolution, AVantage client instantiation via resourceManager, executes the provided avantageMethod (av.commodities.globalIndex for this tool), handles responses and errors, returning JSON stringified data.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}` ); } }