Skip to main content
Glama

Read a help article

read_article
Read-onlyIdempotent

Read the full markdown body of one published help center article by its slug, for example "billing/exporting-invoices".

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe article slug, including its collection.
productIdYesProduct id from list_products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so safety is covered. The description adds the useful detail that the response is the full markdown body rather than metadata, but says nothing about unpublished/missing article behavior or errors.

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 verb, resource, scope ('one published article'), and lookup key, then supplies the format example. No filler.

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 both parameters fully documented and no output schema, the description adequately covers what is returned (markdown body) and how to identify the article. Only edge-case behavior for missing or unpublished slugs is unaddressed.

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 description coverage is 100%, so the baseline is 3, and the description lifts this by giving a concrete slug example ('billing/exporting-invoices') that demonstrates the collection-prefixed format required, which is more actionable than the schema's prose alone.

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?

Specific verb (read) plus specific resource (one published help center article) and even the return format (full markdown body). It does not, however, distinguish itself from close siblings like read_article_source or list_articles, which an agent must choose between.

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?

The word 'published' implicitly scopes usage to live articles versus drafts or source, and requiring a slug plus productId implies this is a lookup-by-identifier read. But there is no explicit statement of when to use this instead of read_article_source, list_articles, or search_articles.

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