Skip to main content
Glama

get_faq

One help FAQ by its slug: question, answer (Markdown), url, topic and related questions.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "slug": "<slug>"
    },
    "name": "get_faq"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesFAQ slug, e.g. from search_help or a /help/q/{slug}/ url

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does disclose the return payload — question, answer in Markdown, url, topic, and related questions — which is genuinely useful with no output schema. However, it says nothing about behavior for an unknown or malformed slug, whether related questions are IDs or objects, or any rate/auth constraints.

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

Conciseness4/5

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

A single compact sentence that front-loads the identity ('One help FAQ by its slug') and then lists the response shape. There is no filler, though the field list reads as a fragment and could be slightly tighter in structure.

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

Completeness4/5

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

For a one-parameter lookup tool with no output schema, the description covers both how it is keyed and what it returns, which is most of what an agent needs. The remaining gap — handling of invalid slugs and the shape of 'related questions' — is minor given the tool's simplicity.

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

Parameters3/5

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

Schema description coverage is 100%, so the single slug parameter is already documented with an example and source hints. The description only reinforces that lookup is by slug and that exactly one FAQ is returned. With one well-documented parameter, the baseline of 3 is appropriate and no extra meaning is added beyond the schema.

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 states a specific verb and resource — retrieving a single help FAQ — and pins down the lookup key ('by its slug'). It also enumerates the returned fields, so an agent knows exactly what it gets back. It does not explicitly distinguish itself from near siblings such as get_page_faqs or get_help_topic, which keeps it out of the top band.

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?

There is no explicit when-to-use guidance: nothing says to call this after search_help returns a slug, nor when to prefer get_page_faqs or get_help_topic instead. The prerequisite that a slug must already be known is only implied by 'by its slug', and the hint about where slugs come from lives in the schema, not the description.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources