Skip to main content
Glama

HelpCenter.io for agents

Get Help Center Design Guide

helpcenter_get_template_guide
Read-onlyIdempotent

Learn what can be customized in a help center's design and exactly how: the model, every edit operation with an example, every component with the settings and values it accepts, theme tokens, custom CSS rules and hooks, scripts and navigation.

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.

Call this with topic 'overview' before your first design edit in a conversation, and with topic 'components' + component_types before adding or configuring a component — the accepted values are exactly the ones the Template Editor offers, and a guess that is off by a word is refused. Generated from the live component registry, so it is always current.

Args:

  • topic: 'overview' (default) | 'components' | 'settings' | 'theme' | 'css' | 'scripts' | 'navigation'.

  • component_types (string[], for 'components'): up to 8, e.g. ['Hero', 'CategoryGrid'].

Returns: markdown; the structured guide in structuredContent. The overview also lists this help center's languages, FAQ sections (for the Faqs component) and uploaded fonts.

Errors: 409 template_migration_required for a classic (v1) help center; 403 when the connection lacks design access.

Input Schema

NameRequiredDescriptionDefault
topicNo'overview' (start here: workflow, model, every operation, the component index, this help center's context), 'components' (full settings of chosen types), 'settings' (brand, theme, meta and page settings `set` accepts), 'theme', 'css', 'scripts' or 'navigation'.overview
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.
component_typesNoFor topic 'components': the types to describe in full, e.g. ['Hero', 'CategoryGrid'].

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover read-only safety, but the description adds substantial context beyond them: edits target a DRAFT (the same one the dashboard editor opens) and nothing reaches visitors until helpcenter_publish_template; classic v1 help centers return template_migration_required; migration is the owner's dashboard decision; and specific errors 409 and 403 are named. It also notes the guide is generated from the live component registry and is always current.

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 core purpose and the when-to-use rules, then the domain model, then args, returns and errors. Some material (topic enum explanation, component_types example) restates the schema, and the paragraph on the design model is dense, but every section carries useful information.

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?

There is no output schema, and the description covers the return format (markdown plus structuredContent, with the overview's extra context), the draft/publish lifecycle, the v1 restriction, and the failure modes. An agent has everything needed to call this correctly on first attempt.

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 real meaning: it explains what 'overview' actually returns (this help center's languages, FAQ sections, uploaded fonts), that component_types is capped at 8 with examples, and that accepted component values come from the Template Editor and a near-miss guess is refused. Only the agent_key parameter is left entirely to 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?

The description states a specific verb and resource ('Learn what can be customized in a help center's design and exactly how') and enumerates the covered domains: the model, edit operations, components, theme tokens, CSS, scripts, navigation. It is clearly the reference/guide tool as distinct from the mutation siblings such as helpcenter_add_template_components or helpcenter_apply_template_theme.

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?

Explicit when-to-use rules: call with 'overview' before the first design edit in a conversation, and with 'components' plus component_types before adding or configuring a component. It also states the constraint that only v2 help centers can be edited and routes publication to helpcenter_publish_template, giving clear alternatives and exclusions.

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