Skip to main content
Glama

get_help_topic

The questions and answers (Markdown) in one help topic, in the site's order, with each FAQ's url. Paged: pass offset from next_offset for more.

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_help_topic"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesTopic slug from list_help_topics, e.g. 'digital-passes'
limitNoMax FAQs (default 25)
offsetNoStart position (default 0)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does reasonably well: it discloses the return content (Q&A in Markdown), the ordering (site's order), that each FAQ carries a url, and the pagination contract via next_offset. It omits error behavior for an invalid slug, which keeps it from a 5.

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?

Two tight sentences, front-loaded with what is returned and followed by the paging rule; no filler or redundancy.

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?

There is no output schema, so the description must describe return values, and it does (Markdown Q&A, site order, per-FAQ url, paged). Only failure modes and the slug's provenance are left implicit.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning beyond the schema by explaining that offset should be taken from next_offset to page through results, which the schema alone does not convey.

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 names a specific resource and content: the questions and answers (Markdown) in one help topic, plus each FAQ's url. It is clearly distinct from list_help_topics and get_faq, though it is phrased as a noun clause rather than a verb+resource statement.

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?

It gives paging guidance ('pass offset from next_offset for more'), which is useful, but never states when to choose this over siblings like search_help or get_faq, nor that the slug comes from list_help_topics (that hint lives only in the schema).

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