technicalIndicators_htTrendline
Calculate the Hilbert Transform Instantaneous Trendline to identify market trends and potential reversals in stock price data.
Instructions
Hilbert Transform - Instantaneous Trendline
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | The stock symbol (e.g., "IBM"). | |
| interval | Yes | Time interval (e.g., "daily", "60min", "weekly"). Check Alpha Vantage docs for valid intervals per indicator. | |
| datatype | No | Data format for the response. | json |
| month | No | Specific month for intraday intervals (YYYY-MM format). | |
| series_type | Yes | The desired price type. |
Implementation Reference
- src/index.ts:1138-1147 (handler)The execute handler for the technicalIndicators_htTrendline tool. It invokes the generic executeAvantageTool function, passing the specific AVantage library method av.technicalIndicators.htTrendline(params) to perform the core computation.execute: ( args, context // Let type be inferred ) => executeAvantageTool( "technicalIndicators_htTrendline", args, context, (av, params) => av.technicalIndicators.htTrendline(params) ),
- src/schemas.ts:231-231 (schema)Zod schema defining the input parameters for the tool, extending the common technical indicators schema with a required series_type (close, open, high, low).export const TechnicalIndicatorsHtTrendlineParamsSchema = TechnicalIndicatorsCommonIndicatorParamsSchema.extend({ series_type: SeriesTypeSchema }).describe('Parameters for HT_TRENDLINE.');
- src/index.ts:1134-1148 (registration)Registration of the technicalIndicators_htTrendline tool with the FastMCP server, including name, description, parameters schema, and execute handler.server.addTool({ name: "technicalIndicators_htTrendline", description: "Hilbert Transform - Instantaneous Trendline", parameters: schemas.TechnicalIndicatorsHtTrendlineParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "technicalIndicators_htTrendline", args, context, (av, params) => av.technicalIndicators.htTrendline(params) ), });
- src/index.ts:38-115 (helper)Generic helper function shared across all tools. Manages API authentication, AVantage client lifecycle using resourceManager, executes the provided avantageMethod, handles errors with UserError, and returns 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}` ); } }