Skip to main content
Glama

HelpCenter.io for agents

List Design Versions

helpcenter_list_template_versions
Read-onlyIdempotent

List the help center's published design versions, newest first, marking the one that is live — with when, by whom and the publish note.

Use it to find a version to bring back with helpcenter_restore_template_version.

Args:

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

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.
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.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so safety is covered. The description adds value beyond that by disclosing ordering (newest first), that the live version is flagged, and that each entry carries timestamp, author and publish note — useful return-shape context given there is no output schema.

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 first sentence front-loads what the tool returns, and the second sentence is a single-purpose usage pointer. The 'Args' block repeats what the schema already says about response_format, which is mild waste, but overall it is tight and easy to scan.

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

Completeness4/5

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

For a small two-parameter read tool with no output schema, the description adequately conveys what comes back (versions, ordering, live marker, metadata). It does not mention result volume or pagination/truncation behavior, which is the main remaining gap.

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 both parameters are already documented in detail, including the agent_key credential semantics and the response_format enum with default. The description only restates response_format and its default, adding no meaning beyond the schema; baseline 3 applies.

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 gives a specific verb and resource ('list the help center's published design versions') plus the ordering ('newest first') and the live-version marker, which cleanly separates it from sibling listers such as helpcenter_list_template_themes and helpcenter_list_article_versions.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

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

It states a concrete use case and names the follow-on tool explicitly: 'Use it to find a version to bring back with helpcenter_restore_template_version.' That is clear routing, though there is no explicit when-not guidance or comparison to a competing list tool.

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