Skip to main content
Glama

Read a help article

get_help_article
Read-onlyIdempotent

Reads one help center article in full, as plain text with its links' addresses, and its public address. Takes an id from search_help_articles.

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": {
      "article_id": "<article_id>"
    },
    "name": "get_help_article"
  }
}

Input Schema

NameRequiredDescriptionDefault
article_idYesThe article's id, from search_help_articles.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/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 a closed-world scope, so the safety profile is covered. The description adds genuinely useful return-shape context (plain text, inline link addresses, public URL), but says nothing about behavior on an unknown or private/draft id, which is the main remaining unknown for a fetch-by-id tool.

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 short clauses, front-loaded with the action and followed by the return shape and id source. No filler or restatement of the tool name.

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?

With one required parameter, full schema coverage, and annotations covering the safety profile, the definition covers nearly everything an agent needs; the return format is described even though no output schema exists. The only gap is failure behavior for invalid or inaccessible article ids.

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 the single parameter already carries a description plus a numeric pattern. The description only repeats the parameter's provenance ('from search_help_articles'), adding no format or validation detail beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Reads'), a specific resource ('one help center article'), and the scope ('in full'), plus what comes back (plain text, link addresses, public address). It also implicitly separates itself from search_help_articles by declaring that the id originates there, so an agent can pick between searching and fetching without opening the schema.

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

Usage Guidelines4/5

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

The phrase 'Takes an id from search_help_articles' establishes the correct workflow: search first, then read by id. What's missing is an explicit exclusion (e.g. don't use this to browse or search, and what to do if the id is unknown), so it stops short of full when/when-not guidance.

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