Skip to main content
Glama

Get help article

get_help_article
Read-only

Read one help article by its slug (as returned by search_help_articles), as plain text, so you can walk the user through it. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe article slug, exactly as returned in a search_help_articles row.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description reinforces this with 'Read-only'. Beyond that it adds genuinely useful behavior not present in structured data: the article is returned as plain text, which tells the agent how to consume the result given there is no output schema.

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?

A single sentence that front-loads the action and resource, then the provenance and output format, with no filler. Every clause earns its place.

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 read tool with no output schema, the description covers action, input source, return format, and safety profile. The only minor gap is failure behavior for an invalid or unknown slug.

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% and the sole parameter's provenance is already documented in the schema ('exactly as returned in a search_help_articles row'). The description echoes this constraint but adds no new syntax or format detail, 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 (read) and resource (one help article), keyed by slug, and explicitly distinguishes itself from the sibling search_help_articles, which returns the slug in the first place. An agent can tell this apart from search_help_articles or get_guide without opening a 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?

Gives clear context for use: read a single article after search_help_articles produced the slug, in order to walk the user through it. It does not state exclusions (e.g. what to do if the slug is stale or not found), so it falls short of a full when/when-not rubric.

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