Skip to main content
Glama

HelpCenter.io for agents

Get Help Center Template

helpcenter_get_template
Read-onlyIdempotent

Read a help center's current design (the draft): its status, the Template Editor link for the customer to review, and an outline of every page — or one part of the draft in full.

A help center's design is its v2 template: theme tokens (colours for light and dark mode, fonts, radius, density), six page kinds (home, category, article, search, contact, notFound), each built from six regions (header, hero, sidebar, main, footer, utility) holding ordered components, plus a global navigation menu, custom CSS and scripts. You edit a DRAFT — the same draft the dashboard's Template Editor opens, with a live preview — and nothing reaches visitors until helpcenter_publish_template. Only v2 help centers can be edited: a classic (v1) one answers template_migration_required, and migrating is the owner's decision, made in the dashboard.

Start here. The outline (the default) gives every component's id and type with only the settings that differ from their defaults, the theme, brand and meta in full, and indexes of navigation, scripts and custom CSS — enough to plan an edit without reading the whole document. Then read the part you are about to change in full: section 'component' with its id, 'page', 'region', a CSS block or script by id.

It also returns the draft's etag: pass it to an edit tool or to helpcenter_publish_template to be refused (instead of silently overwriting) if someone changed the draft meanwhile — a person may be editing it in the Template Editor at the same time.

Args:

  • section: 'outline' (default) | 'document' | 'brand' | 'theme' | 'meta' | 'navigation' | 'scripts' | 'custom_css' | 'page' | 'region' | 'component' | 'translations'.

  • page / region / id: for the 'page', 'region', 'component', 'custom_css' and 'scripts' sections.

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

Errors: 409 template_migration_required for a classic (v1) help center; 404 for an unknown component, CSS or script id.

Input Schema

NameRequiredDescriptionDefault
idNoComponent / CSS block / script id, for those sections.
pageNoPage kind: home, category, article, search, contact or notFound.
regionNoRegion of the page: header, hero, sidebar, main, footer or utility.
sectionNo'outline' (default: status, links and a compact map of the draft — every component id, and only settings that differ from their defaults), or one part of the draft document: 'page' (with page), 'region' (with page and region), 'component' (with id), 'custom_css' / 'scripts' (all, or one with id), 'brand', 'theme', 'meta', 'navigation', 'translations', or the whole 'document' (large — prefer parts).outline
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.
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
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered; the description earns credit for adding the draft-vs-live boundary, the fact that v2 is editable only, and the 409 template_migration_required and 404 unknown-id errors. It also supplies the concurrency (etag) contract, which no annotation conveys. It stops short of describing default settings trimming effects deeply, which is why this sits at a solid 3 rather than higher.

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-loads the one-line purpose, then domain model, then sequencing, then arguments and errors — a clean structure with no wasted framing. It loses a point for restating enum membership in prose ('six page kinds... six regions...') and again in the Args list, which the schema already enumerates.

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 and a complex nested domain, the description carries the burden of explaining what comes back at each level — the outline's trimmed settings, the theme/brand/meta in full, and the indexes of navigation, scripts, and CSS. It also closes the two failure modes an agent would otherwise hit blind (v1 help centers, unknown ids).

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 coverage is 100%, so the baseline is 3, but the description adds the conditional relationships the schema cannot express — which sections require page, region, or id — plus the ordering hint that 'document' is large and parts are preferred. Minor deduction because the Args block partly repeats the enum values already present in the schema.

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 precise verb and resource ('Read a help center's current design (the draft)') and immediately scopes the output: status, Template Editor link, page outline, or one part in full. It also distinguishes itself from the family of sibling mutations by naming helpcenter_publish_template as the gate that makes the draft live.

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 explicit sequencing guidance: 'Start here,' then use the outline to plan an edit and only then read the specific component/page/region/CSS block/script in full. It also explains when to carry the returned etag forward (edit tools and publish) so concurrent Template Editor edits cause a refusal rather than a silent overwrite.

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