Skip to main content
Glama

HelpCenter.io for agents

Create a Redirect

helpcenter_create_redirect
DestructiveIdempotent

Send an old path of the help center ('from') on to one of its pages ('to') with a 301, for as long as nothing else on the help center answers that path. A path that already has a redirect is re-pointed, never duplicated.

Works once the user has claimed the help center, verified their email address and activated a plan; until then it answers capability_locked with the user's next step (helpcenter_get_help_center shows it too).

The target must be a published page of this help center, given as its path: a redirect to another site is refused (external_target_forbidden), and so is one to a page that does not exist or is still a draft (target_not_found). Also refused: a path no visitor's request could reach (source_not_redirectable — for example a one-segment path like '/pricing', which the help center reads as a language), a loop (redirect_loop), and a chain of more than 3 redirects (too_many_hops).

For many redirects at once, use helpcenter_bulk_create_redirects.

Args:

  • from (string, required): like '/hc/en-us/articles/360001-Billing'.

  • to (string, required): like '/en/content/billing'.

Returns: { action: "created" | "updated", redirect: { id, from, to } }.

Input Schema

NameRequiredDescriptionDefault
toYesWhere it goes: a page of THIS help center, as a path like '/en/content/billing' (an agent key may not redirect to another site).
fromYesA path of the old help center, like '/hc/en-us/articles/360001-Billing': no scheme or host, no query or fragment, not the home page.
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.8/5.0
Behavior5/5

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

Goes well past the annotations: it discloses gating preconditions, a full catalogue of refusal codes with the reason for each (external_target_forbidden, target_not_found, source_not_redirectable with the one-segment rationale, redirect_loop, too_many_hops), and the upsert behavior that justifies idempotentHint. This is the kind of context the destructiveHint=true annotation cannot convey on its own.

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-loads the core action and destructive upsert behavior, then groups prerequisites and refusals into distinct paragraphs. The error-code sentence is long but each clause adds an actionable distinction; minor compression is possible in the Args examples that repeat schema text.

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?

With no output schema, the description supplies the return shape ({ action: created|updated, redirect }). Combined with prerequisites, refusal taxonomy, and the sibling handoff, an agent has everything needed to invoke this correctly and to interpret failures.

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% and already covers path format constraints, so the description is not carrying that burden alone. It still adds meaning the schema lacks: 'to' must be a published (non-draft) page of this help center, and 'from' must be a visitor-reachable path — semantic constraints that the string schema cannot express. Parameter examples largely duplicate the schema's own examples.

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?

States a specific verb and resource ('Send an old path of the help center... with a 301') and defines the exact semantics: re-pointing rather than duplicating, and the constraint that it applies only while nothing else answers the path. It is unambiguously distinguishable from helpcenter_bulk_create_redirects, which is named explicitly.

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 explicit when-to-use routing ('For many redirects at once, use helpcenter_bulk_create_redirects') and states prerequisites plus the capability_locked failure with a recovery path (helpcenter_get_help_center). Exclusion conditions are enumerated concretely rather than left to inference.

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