Skip to main content
Glama

HelpCenter.io for agents

Change Design Settings

helpcenter_update_template_settings
DestructiveIdempotent

Change document-level design settings in the draft: theme colours (light and dark), fonts, corner radius and density; the brand (name, logo, favicon); meta and SEO; and per-page settings such as a page's layout or how a category page lists its articles.

It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template.

Each entry is a path and its new value — 'theme.colors.primary' → '#635bff' — or a whole group at once: 'theme.colors' → {primary, accent, …}. The paths and the values each accepts are in helpcenter_get_template_guide (topic 'settings'); anything else is refused with the list of what is accepted. Colours take hex, rgb() or hsl() (stored as hex); set theme.darkColors alongside theme.colors so dark mode stays readable. An image setting (brand.logoAssetId, brand.faviconAssetId) takes {source_url: 'https://…'}: the image is copied onto this help center. Region styling has its own tool (helpcenter_update_template_region). This is the guide's set operation.

Args:

  • settings (array, 1-50): {path, value}; null clears a nullable setting.

  • etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since.

Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

Input Schema

NameRequiredDescriptionDefault
etagNoOptimistic lock: the draft etag from your last read, or the one your last edit returned. When given, the call is refused (stale_draft) if someone changed the draft since — so you never build on a state you have not seen. Omit to apply to the current draft.
settingsYesThe settings to change. Applied in order, all-or-nothing: if one is refused, nothing from this call is saved and the error names it by position (operation 0 is the first entry).
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.9/5.0
Behavior5/5

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

Beyond the annotations it discloses that edits are draft-only with live preview and never reach visitors until publish, that stale_draft etag conflicts refuse the call, that unknown paths are rejected with the accepted list, that colours are normalised to hex, and that image settings copy the asset onto the help center. That is substantially more operational context than the destructive/idempotent/openWorld hints convey.

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?

The information is front-loaded: the scope sentence comes first, then draft/publish safety, then path syntax, then args and returns. It is dense and long, with somewhat nested parentheses, but virtually every sentence carries distinct guidance rather than restating the schema or annotations.

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 3-parameter, non-read-only tool with no output schema, the description covers the mutation's blast radius, the draft/publish lifecycle, prerequisite reads for ids and paths, a migration edge case, and the return contents (new ids, warnings, draft status and etag). An agent has enough to call it correctly and to relay results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, but the prose adds real meaning: paths may target a single leaf or a whole group object, null clears a nullable setting, colour formats and the theme.darkColors pairing rule, the {source_url} shape for image settings, and the precise etag conflict semantics. The all-or-nothing ordering and positional error reporting is explained in the schema, and the description reinforces the workflow around it.

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 opens with a specific verb and resource ("Change document-level design settings in the draft") and enumerates the setting families covered: theme colours/fonts/corner radius/density, brand assets, meta/SEO, and per-page layout. It explicitly names the sibling it is not (helpcenter_update_template_region) and the related publish/get tools, so an agent can separate it from the other template-editing siblings without opening a 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?

It gives explicit when-to-use and when-not guidance: edit the draft here, publish only via helpcenter_publish_template and only when the customer asks, use helpcenter_update_template_region for region styling, and fetch ids from helpcenter_get_template. It also states a hard exclusion — v2 help centers only, classic ones return template_migration_required.

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