Skip to main content
Glama

HelpCenter.io for agents

Get HelpCenter Article

helpcenter_get_article
Read-onlyIdempotent

Read one article by id from the connected HelpCenter.io help center.

Use this when you already know the id — after a search, or before editing — instead of paging through helpcenter_list_articles to find it again. Read-only.

Also the way to check whether an article has unpublished staged edits waiting on it: the response carries has_staged_changes, staged_locales and staged_updated_at. Check that before a live update, or your edit and somebody else's staged work will collide.

Args:

  • article_id (number, required): id of the article.

  • response_format ('markdown' | 'json'): default 'markdown'.

Returns: { status: "success", article: {...} } — the full article, including per-language title/content/slug, categories, external_id, and the staged-changes flags.

Errors: 404 if the id is unknown OR belongs to another help center — the endpoint deliberately does not distinguish the two, so a 404 is not proof the article does not exist somewhere else.

Input Schema

NameRequiredDescriptionDefault
agent_keyYesThe api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content.
article_idYesId of the article to read.
response_formatNoOutput format: 'markdown' for a human-readable summary or 'json' for the full structured payload.markdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds genuinely new behavior: the response carries has_staged_changes/staged_locales/staged_updated_at, and that a 404 conflates unknown-id with wrong-help-center, which materially changes how an agent should interpret a failure. It does not cover rate limits or pagination (not applicable here).

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?

Front-loaded with purpose then usage, followed by Returns and Errors sections that earn their space. The explicit 'Args' block largely duplicates the schema and could be trimmed, and 'Read-only.' is redundant with readOnlyHint=true, but overall it is well-organized and readable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so concretely (full article with per-language title/content/slug, categories, external_id, staged-changes flags) plus error semantics. For a read tool with a well-documented schema, nothing needed to call it correctly is missing.

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%, so all three parameters are already documented, including the response_format enum semantics and the agent_key credential handling. The description's 'Args' section mostly restates that. Baseline 3 applies because the schema is doing the heavy lifting.

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 article by id) in the first sentence, and explicitly contrasts with the two nearest siblings (helpcenter_list_articles, and implicitly search_articles via the 'after a search' reference). An agent can route correctly 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 Guidelines5/5

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

Gives an explicit when-to-use condition ('already know the id — after a search, or before editing'), names the alternative it replaces ('instead of paging through helpcenter_list_articles'), and adds a second, non-obvious use case: checking has_staged_changes before a live update to avoid colliding with staged edits.

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