Skip to main content
Glama

get_help_article

Read-onlyIdempotent

Get one help guide in full by its slug: what the feature is, why it helps and the real steps to use it, in the language asked for, with its page and its dashboard screen.

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

Input Schema

NameRequiredDescriptionDefault
slugYesThe guide's slug, from search_help (e.g. "deposits").
languageNoOptional. The language to search and answer in: en, de, fr, es, it, nl, pt, da, sv, nb, fi, pl, ja, cs (a tag like de-DE works too). Defaults to English; a language Bookatu has no catalog for reads English.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description's added value is the content shape of the response (guide body plus its page and dashboard screen), which matters since there is no output schema, but it says nothing about what happens when a slug is unknown or how large the payload is.

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 front-loaded sentence with no filler; every clause (content preview, language, extra return fields) carries information. It is somewhat run-on with the colon-plus-list construction, but nothing is redundant.

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 two-parameter read tool with no output schema, the description covers what is retrieved (full article body with steps) and the extra return artifacts (page, dashboard screen), and annotations handle the safety/metadata side. Only error behavior and freshness/caching, which an agent rarely needs to select this tool, are absent.

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 coverage is 100% and both parameters are fully documented there, including the language list and the English-fallback rule. The description only echoes 'by its slug' and 'in the language asked for' without adding format or constraint detail beyond the schema, so baseline 3 applies.

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?

States a specific verb and resource ("Get one help guide in full") plus the lookup key ("by its slug") and enumerates the content returned (what the feature is, why it helps, steps, page, dashboard screen). It is distinguishable from search_help by 'in full' versus searching, though the description never names that sibling explicitly.

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?

Usage is only implied: the agent must infer it should call this after having obtained a slug (the schema description mentions search_help, not the description itself). There is no explicit when-to-use/when-not statement or named alternative in 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