Skip to main content
Glama

HelpCenter.io for agents

Get Help Center Status

helpcenter_get_help_center
Read-onlyIdempotent

Read the status of the help center you created: whether the user has claimed it, when it is deleted, how full it is, a fresh preview link, and what is left to set up.

Call it after writing content, before giving the user the claim link, and whenever a tool answers capability_locked.

Returns (also as structuredContent): claimed; claim {state: open | held | claimed, held_until}; expires_at (null once claimed, and while a migration request holds it); counts and limits {articles, categories, languages}; claim_url (while unclaimed); preview_url; next_step {code, instruction, url}, also under setup; setup {claimed, email_verified, plan_activated}; capabilities {content, design, redirects, custom_domain}: what agent_key may do now.

  • preview_url: shows the help center as its readers will see it, page to page, for one hour (published articles only). A new link on every call. Open it to check your work, or give it to the user to look before they claim.

  • next_step: pass its instruction on to the user as it is. not_claimed: give the user claim_url. wait_for_migration: a migration request is moving content; follow it with helpcenter_get_migration_request. email_unverified, plan_not_activated, make_public: the user's steps in their dashboard after the claim. You cannot make a help center public: only the user can.

  • capabilities: redirects and custom_domain unlock only once the user has claimed the help center, verified their email address and activated a plan.

Args:

  • site_id (number, required): as helpcenter_create_help_center returned it.

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

Input Schema

NameRequiredDescriptionDefault
site_idYesThe site_id helpcenter_create_help_center returned for this help center.
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.3/5.0
Behavior4/5

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

Well beyond the readOnly/idempotent annotations: it discloses that preview_url expires in one hour and is regenerated on every call, that expires_at is null once claimed or held by a migration, that capability unlocking depends on claim + email verification + plan activation, and that the agent cannot make a help center public. The one point of tension is a fresh preview URL per call alongside idempotentHint=true, but this reflects no side effects on stored data rather than an outright contradiction.

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 purpose, then call timing, then a clearly bulleted breakdown of preview_url, next_step codes and capabilities. Slightly long, with next_step explained both inline and in the 'Returns' header list, but every line carries actionable information.

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?

With no output schema, the description carries the return-value burden and does it thoroughly, listing every field returned plus structuredContent and decoding next_step codes. Minor gap: it never mentions response_format behavior ('markdown' summary vs 'json' full payload), which only the schema covers.

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 coverage is 100% and the schema already explains site_id, agent_key handling and response_format in detail, including the credential-never-shown rule. The description only restates 'site_id as helpcenter_create_help_center returned it' and adds nothing new about parameters, so the baseline 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?

Opens with a specific verb and resource ('Read the status of the help center you created') and immediately enumerates the exact facets returned: claim state, deletion, capacity, preview link, remaining setup. This is clearly distinguishable from siblings like helpcenter_get_migration_request or helpcenter_get_staged_changes.

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 concrete trigger conditions: after writing content, before handing over the claim link, and whenever a tool answers capability_locked. It also names the hand-off path (follow wait_for_migration with helpcenter_get_migration_request), so the agent knows both when to call and what to do next.

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