Skip to main content
Glama

get_all_faqs

Retrieve all frequently asked questions across all categories to provide comprehensive support information and chatbot assistance.

Instructions

Get all available FAQs across all categories

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The execute handler function for the 'get_all_faqs' tool. It retrieves all FAQs from the ChatbotService, formats them into a JSON response, and handles errors.
    execute: async () => {
      try {
        logger.info('Getting all FAQs');
    
        const faqs = chatbotService.getAllFAQs();
    
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(
                {
                  success: true,
                  count: faqs.length,
                  faqs: faqs.map(faq => ({
                    question: faq.question,
                    answer: faq.answer,
                    category: faq.category
                  }))
                },
                null,
                2
              )
            }
          ]
        };
      } catch (error) {
        logger.error('Failed to get all FAQs', error);
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(
                {
                  success: false,
                  error: error instanceof Error ? error.message : 'Unknown error'
                },
                null,
                2
              )
            }
          ],
          isError: true
        };
      }
    }
  • Zod input schema for the tool: no parameters required.
    parameters: z.object({}),
  • src/index.ts:60-68 (registration)
    Registration of chatbotTools (including get_all_faqs) into allTools object, which is used by the MCP server's ListTools and CallTool request handlers.
    const ticketTools = createTicketTools(apiService);
    const chatbotTools = createChatbotTools(chatbotService);
    const pdfTools = createPDFTools(pdfService);
    
    const allTools = {
      ...ticketTools,
      ...chatbotTools,
      ...pdfTools
    };
  • Helper method in ChatbotService that returns all loaded FAQs.
    getAllFAQs(): SupportFAQ[] {
      return this.faqs;
    }
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 action but doesn't describe traits like whether this is a read-only operation, potential rate limits, authentication needs, or what the return format looks like (e.g., list structure, pagination). For a tool with zero annotation coverage, this is a significant gap in transparency.

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, clear sentence with no wasted words, efficiently conveying the core purpose. It's front-loaded and appropriately sized for a simple tool, making it easy to parse quickly.

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 annotations, no output schema), the description adequately covers the basic purpose. However, it lacks details on behavioral aspects like return format or operational constraints, which would be helpful for an agent to use it correctly. It's minimally viable but has clear gaps in 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 parameters need documentation. The description doesn't add parameter details, which is appropriate here. Baseline is 4 for zero parameters, as the description doesn't need to compensate for any schema gaps.

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 verb 'Get' and resource 'all available FAQs across all categories', making the purpose specific and understandable. It distinguishes from sibling tools like 'get_faqs_by_category' by emphasizing 'all categories' rather than filtering. However, it doesn't explicitly contrast with 'search_faqs', which might also retrieve FAQs, leaving slight ambiguity.

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

Usage Guidelines3/5

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

The description implies usage by specifying 'all categories', suggesting this tool is for broad retrieval without filtering. However, it doesn't explicitly state when to use this versus alternatives like 'get_faqs_by_category' (for category-specific FAQs) or 'search_faqs' (for keyword-based queries), nor does it mention prerequisites or exclusions, leaving usage context partially inferred.

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