Skip to main content
Glama

HelpCenter.io for agents

Publish the Help Center Design

helpcenter_publish_template
Destructive

Put the draft live: every visitor sees the new design from now on. Records a version (restorable later) and starts a fresh draft from it — exactly the Template Editor's Publish button.

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.

This is the ONE template call that changes the live help center. Publish only when the customer has asked you to — ideally after they reviewed the draft in the Template Editor (the customizer link from helpcenter_get_template). Pass the etag they reviewed, so a draft that changed after their review is refused rather than published unseen.

Args:

  • message (string, optional): a note for the version history, e.g. 'Brand refresh'.

  • etag (string, optional): the reviewed draft's etag.

Returns: the published version and the new draft status.

Errors: 409 nothing_to_publish when the draft matches the live design; 412 stale_draft when the draft changed after the etag.

Input Schema

NameRequiredDescriptionDefault
etagNoThe draft etag the customer reviewed. When given, publishing is refused if the draft changed since — so exactly what was reviewed goes live.
messageNoA short note for the version history, e.g. 'Brand refresh'.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and idempotentHint=false; the description adds genuine context beyond them: a version is recorded and restorable later, a fresh draft is started from the published one, changes are immediately visible to every visitor, and only v2 help centers qualify. It also enumerates the failure modes (409 nothing_to_publish, 412 stale_draft) and the exact semantics of the etag guard. It does not state irreversibility timing or permission requirements beyond the agent_key note, keeping it just short of a 5.

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 the effect in sentence one, followed by preconditions, args, returns, and errors in a scannable layout. The middle paragraph anatomizing the template (theme tokens, six page kinds, six regions) is informative but heavier than a publish tool strictly needs, costing a point on tightness.

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?

For a destructive, non-idempotent, open-world mutation with no output schema, the description covers effect, prerequisites, the reviewed-etag workflow, what is created (version plus fresh draft), the return summary, and both named error codes. Nothing an agent needs to invoke it safely is missing.

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 both optional parameters are already documented; the description nonetheless reinforces intent by prescribing passing the etag the customer reviewed and giving a version-history note example ('Brand refresh'). The added value is in the rationale (refuse rather than publish unseen) rather than new syntax, so this sits modestly above the 3 baseline.

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?

Opens with a concrete verb and effect: 'Put the draft live: every visitor sees the new design from now on', and explicitly claims scope ('the ONE template call that changes the live help center'), which separates it from siblings like helpcenter_update_template_region or helpcenter_publish_staged_changes. The 'exactly the Template Editor's Publish button' anchor makes the mental model unmistakable.

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?

States both when to use ('Publish only when the customer has asked you to') and the recommended precondition (customer reviewed the draft via the customizer link from helpcenter_get_template), plus the etag safeguard against publishing an unreviewed draft. It also names the blocking condition for v1 help centers (template_migration_required, owner decision in dashboard), which routes the agent away from this tool when it cannot apply.

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