technicalIndicators_aroon
Calculate Aroon indicator for stock symbols using historical price data. Analyze trends by specifying time intervals, periods, and output format through the MCP Avantage server.
Instructions
Aroon
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datatype | No | Data format for the response. | json |
| interval | Yes | Time interval (e.g., "daily", "60min", "weekly"). Check Alpha Vantage docs for valid intervals per indicator. | |
| month | No | Specific month for intraday intervals (YYYY-MM format). | |
| symbol | Yes | The stock symbol (e.g., "IBM"). | |
| time_period | Yes | Number of data points used to calculate the indicator. |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"description": "Parameters for AROON.",
"properties": {
"datatype": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json",
"csv"
],
"type": "string"
},
"interval": {
"description": "Time interval (e.g., \"daily\", \"60min\", \"weekly\"). Check Alpha Vantage docs for valid intervals per indicator.",
"type": "string"
},
"month": {
"description": "Specific month for intraday intervals (YYYY-MM format).",
"type": "string"
},
"symbol": {
"description": "The stock symbol (e.g., \"IBM\").",
"type": "string"
},
"time_period": {
"description": "Number of data points used to calculate the indicator.",
"type": "string"
}
},
"required": [
"symbol",
"interval",
"time_period"
],
"type": "object"
}
Implementation Reference
- src/index.ts:1310-1324 (registration)Registration of the 'technicalIndicators_aroon' tool, including its inline handler that delegates execution to the executeAvantageTool helper and ultimately to the Alpha Vantage library's aroon method.server.addTool({ name: "technicalIndicators_aroon", description: "Aroon", parameters: schemas.TechnicalIndicatorsAroonParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "technicalIndicators_aroon", args, context, (av, params) => av.technicalIndicators.aroon(params) ), });
- src/schemas.ts:244-244 (schema)Zod schema for input parameters of the technicalIndicators_aroon tool, extending a base schema for time-period based technical indicators (requires symbol, interval, time_period).export const TechnicalIndicatorsAroonParamsSchema = TechnicalIndicatorsTimePeriodOnlyParamsSchema.describe('Parameters for AROON.');
- src/index.ts:38-115 (helper)Generic helper function used by the technicalIndicators_aroon handler (and all similar tools) to resolve API key, manage AVantage client resources, execute the library method, and format the response.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}` ); } }