Skip to main content
Glama

get_icons_guide

Access the PrimeIcons usage guide to find and implement icons in Angular UI development with PrimeNG components.

Instructions

Obtiene la guía de uso de PrimeIcons

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Core handler function that implements the tool logic for get_icons_guide: checks cache for 'icons' guide, scrapes from DocsScraperService if missing, caches the result, formats with formatGuideDoc, and returns the response or error.
    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}`
        );
      }
    }
  • Schema definition for the get_icons_guide tool, including name, description, and empty input schema (no parameters required).
    export function createGetIconsGuideSchema(): Tool {
      return {
        name: "get_icons_guide",
        description: "Obtiene la guía de uso de PrimeIcons",
        inputSchema: {
          type: "object",
          properties: {},
        },
      };
    }
  • Registration: Instantiates the GetIconsGuideTool with scraper and cache services.
    this.getIconsGuideTool = new GetIconsGuideTool(
      this.docsScraperService,
      this.cacheService
    );
  • Registration: Handles tool calls by dispatching to the getIconsGuideTool's run method.
    case "get_icons_guide":
      return await this.getIconsGuideTool.run(args);
  • Tool class specific to get_icons_guide, extending GetGuideTool and configuring tool name and guide name ('icons').
    export class GetIconsGuideTool extends GetGuideTool {
      constructor(scraperService: DocsScraperService, cacheService: CacheService) {
        super('get_icons_guide', 'icons', scraperService, cacheService);
      }
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states what the tool does ('Obtiene la guía de uso') without mentioning any behavioral traits like whether it returns a file, text, or structured data; if it requires authentication; or if there are rate limits. This leaves significant gaps for a tool with no 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 in Spanish ('Obtiene la guía de uso de PrimeIcons') that directly states the tool's purpose without any wasted words. It's appropriately sized for a simple, no-parameter tool and is front-loaded with the core action.

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. It doesn't explain what 'la guía de uso' entails (e.g., a document, examples, or instructions), how the output is structured, or any prerequisites. For a tool with no structured data to rely on, this leaves the agent with insufficient context to use it effectively.

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 0 parameters with 100% schema description coverage, so the schema fully documents the lack of inputs. The description doesn't need to add parameter information, and it appropriately doesn't mention any parameters, earning a baseline score of 4 for not introducing confusion or redundancy.

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 action ('Obtiene' - Gets) and the resource ('la guía de uso de PrimeIcons'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'get_installation_guide' or 'get_theming_guide' that also retrieve guides, leaving some ambiguity about what specifically distinguishes this tool.

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. With sibling tools like 'get_installation_guide' and 'get_theming_guide' available, there's no indication of whether this is for general usage instructions, specific icon documentation, or something else, leaving the agent to guess based on the tool name alone.

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