get_installation_guide
Retrieve the installation guide and initial setup instructions for PrimeNG to begin using Angular UI components in your project.
Instructions
Obtiene la guía de instalación y configuración inicial de PrimeNG
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/GetGuideTool.ts:28-50 (handler)Core handler logic for get_installation_guide tool (inherited by GetInstallationGuideTool): checks cache for 'installation' guide, scrapes from DocsScraperService if missing, caches result, formats with formatGuideDoc, handles errors.async execute(_args: Record<string, any>): Promise<ToolResponse> { try { // Check cache first const cachedGuide = await this.cacheService.getGuide(this.guideName); if (cachedGuide) { logger.info(`Returning cached guide: ${this.guideName}`); return this.createResponse(formatGuideDoc(cachedGuide)); } // Scrape guide const guide = await this.scraperService.scrapeGuide(this.guideName); // Cache the result await this.cacheService.setGuide(this.guideName, guide); return this.createResponse(formatGuideDoc(guide)); } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return this.createErrorResponse( `Failed to get ${this.guideName} guide: ${errorMessage}` ); } }
- Specific tool class for get_installation_guide: extends GetGuideTool, configures tool name and 'installation' guide section.export class GetInstallationGuideTool extends GetGuideTool { constructor(scraperService: DocsScraperService, cacheService: CacheService) { super('get_installation_guide', 'installation', scraperService, cacheService); } }
- src/models/ToolSchemas.ts:111-120 (schema)Tool schema definition: no input params required, description for installation guide.export function createGetInstallationGuideSchema(): Tool { return { name: "get_installation_guide", description: "Obtiene la guía de instalación y configuración inicial de PrimeNG", inputSchema: { type: "object", properties: {}, }, }; }
- src/server/PrimeNGServer.ts:151-154 (registration)Tool instantiation: creates GetInstallationGuideTool instance with scraper and cache services.this.getInstallationGuideTool = new GetInstallationGuideTool( this.docsScraperService, this.cacheService );
- src/server/PrimeNGServer.ts:221-222 (registration)Tool dispatch registration: handles 'call_tool' requests for get_installation_guide by calling tool.run().case "get_installation_guide": return await this.getInstallationGuideTool.run(args);