Skip to main content
Glama

get_installation_guide

Retrieve the installation and initial configuration guide for PrimeNG, an Angular UI component library, to set up the framework in your Angular projects.

Instructions

Obtiene la guía de instalación y configuración inicial de PrimeNG

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Core handler logic that executes the tool: checks cache for 'installation' guide, scrapes from docs if missing using DocsScraperService.scrapeGuide('installation'), 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' that configures GetGuideTool with tool name and 'installation' guide section.
    export class GetInstallationGuideTool extends GetGuideTool {
      constructor(scraperService: DocsScraperService, cacheService: CacheService) {
        super('get_installation_guide', 'installation', scraperService, cacheService);
      }
    }
  • Defines the tool schema including name, description, and empty input schema (no parameters required).
    /**
     * Creates the schema for get_installation_guide tool
     */
    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: {},
        },
      };
    }
  • Instantiates the GetInstallationGuideTool instance with DocsScraperService and CacheService during server initialization.
    this.getInstallationGuideTool = new GetInstallationGuideTool(
      this.docsScraperService,
      this.cacheService
    );
  • Registers the tool handler in the MCP call tool request switch statement, delegating to tool.run(args).
    case "get_installation_guide":
      return await this.getInstallationGuideTool.run(args);
  • Registers the tool schema in the MCP list tools request handler.
    createGetInstallationGuideSchema(),
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure but offers minimal information. It states what the tool does ('gets the installation guide') but doesn't describe return format, error conditions, rate limits, authentication needs, or other behavioral traits. This leaves significant gaps for a tool with zero annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized for a simple tool and front-loads the essential information, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of annotations and output schema, the description is incomplete for effective tool use. While it states what the tool retrieves, it doesn't explain what format the installation guide comes in (e.g., text, HTML, structured data), potential limitations, or how to handle the result. For a tool with no structured behavioral hints, this leaves too many unknowns.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, and schema description coverage is 100%, so there are no parameters to document. The description appropriately doesn't discuss parameters, which is correct for a parameterless tool. A baseline of 4 is appropriate since there's nothing to compensate for.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with a specific verb ('obtiene' - gets) and resource ('guía de instalación y configuración inicial de PrimeNG'), making it immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'get_tailwind_guide' or 'get_theming_guide' beyond the resource name, which prevents a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, appropriate contexts, or exclusions, leaving the agent to infer usage based solely on the tool name and description without explicit direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/hnkatze/PrimeNG_MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server