Skip to main content
Glama

get_faq_categories

Retrieve all available FAQ categories from the FitSlot support system to help users find relevant help topics and solutions.

Instructions

Get all available FAQ categories

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler for get_faq_categories tool: no input params, calls service to get categories, returns JSON success/error response.
    get_faq_categories: {
      description: 'Get all available FAQ categories',
      parameters: z.object({}),
      execute: async () => {
        try {
          logger.info('Getting FAQ categories');
    
          const categories = chatbotService.getCategories();
    
          return {
            content: [
              {
                type: 'text',
                text: JSON.stringify(
                  {
                    success: true,
                    categories
                  },
                  null,
                  2
                )
              }
            ]
          };
        } catch (error) {
          logger.error('Failed to get FAQ categories', error);
          return {
            content: [
              {
                type: 'text',
                text: JSON.stringify(
                  {
                    success: false,
                    error: error instanceof Error ? error.message : 'Unknown error'
                  },
                  null,
                  2
                )
              }
            ],
            isError: true
          };
        }
      }
    },
  • src/index.ts:60-68 (registration)
    Tool registration: creates chatbotTools via createChatbotTools(chatbotService) and merges into allTools used by MCP server for tool listing and execution.
    const ticketTools = createTicketTools(apiService);
    const chatbotTools = createChatbotTools(chatbotService);
    const pdfTools = createPDFTools(pdfService);
    
    const allTools = {
      ...ticketTools,
      ...chatbotTools,
      ...pdfTools
    };
  • Helper method getCategories() extracts unique categories from the faqs array populated in initializeFAQs().
    getCategories(): string[] {
      return [...new Set(this.faqs.map(faq => faq.category))];
    }
  • Input schema: empty object (no parameters required).
    parameters: z.object({}),
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 states the tool retrieves categories but doesn't describe return format (e.g., list structure, pagination), error conditions, or performance characteristics. For a read operation with zero annotation coverage, this leaves significant gaps in understanding how the tool behaves.

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 front-loads the core purpose without unnecessary words. It's appropriately sized for a simple tool with no parameters, making it easy to parse quickly. Every word earns its place by conveying essential information.

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

Completeness3/5

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

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is minimally adequate but lacks depth. It doesn't explain what 'FAQ categories' entail or how results are structured, which could help an agent use the output effectively. For a basic read tool, it meets the minimum but doesn't provide rich context.

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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add parameter details, which is appropriate here. A baseline of 4 is given since the schema fully handles parameters, and the description doesn't need to compensate.

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 ('Get') and resource ('all available FAQ categories'), making the purpose immediately understandable. It distinguishes from siblings like 'get_all_faqs' (which gets FAQ items) and 'get_faqs_by_category' (which filters by category), though it doesn't explicitly mention these distinctions. The description avoids tautology by specifying what is being retrieved.

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 like 'get_all_faqs' or 'search_faqs'. It doesn't mention prerequisites, context, or exclusions, leaving the agent to infer usage based on tool names alone. This lack of explicit guidance reduces effectiveness in tool selection.

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/osmarsant/fitslot-mcp'

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