Skip to main content
Glama

HelpCenter.io for agents

Create HelpCenter Category

helpcenter_create_category

Create a category in the HelpCenter.io help center bound to your API key.

Requires a write-scoped API key. This is what lets you build a help center's structure rather than only fill it in: create the categories first, then file articles into them with helpcenter_create_article's category_id.

Args:

  • name (object, required): per-language category name, e.g. { "en": "Billing" }. Every key must be a language enabled on this help center.

  • description (object, optional): per-language description.

  • parent_id (number, optional): parent category id, for nesting. Omit or pass 0 for a top-level category.

  • icon (string, optional): icon identifier, max 190 chars.

  • position (number, optional): sibling order, ascending. Omit to place the category after everything already arranged.

Returns: { status: "success", category: {...} } with the new id, 201.

Categories are created public. Privacy (unlisted, team-only, private) stays a dashboard setting, because a private category with no shares would be invisible to everyone including its author.

Errors: 403 if the key is read-scoped; 422 for a language the help center does not have, or a parent_id outside it.

Input Schema

NameRequiredDescriptionDefault
iconNoIcon identifier for the category (max 190 chars).
nameYesPer-language category name, e.g. { "en": "Billing" }. Required.
positionNoSibling order, ascending. Omit to place the category after everything already arranged.
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.
parent_idNoId of the parent category, for nesting. Must belong to this site. Use 0 or omit for a top-level category.
descriptionNoPer-language category description.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the annotations (which only say it is a non-readonly, non-destructive, non-idempotent, open-world write): it discloses the write-scoped key requirement, the 403 for read-scoped keys, 422 conditions for unknown language or out-of-scope parent_id, the 201 success shape, and the important side effect that categories are created public. That default-visibility note is exactly the kind of non-obvious behavior an agent would otherwise get wrong.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the purpose, then the auth prerequisite, then the workflow rationale, and closes with returns and errors. The Args block largely mirrors the schema, but it is compact and skimmable, and no sentence is wasted on filler.

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 and status code, and it covers auth, default visibility, and the two failure modes for a nested-object, 6-parameter mutation tool. An agent has everything needed to call it correctly on the 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 already 100%, so the baseline is 3, but the description adds real meaning beyond the schema: every name/description key must be a language enabled on this help center, and parent_id may be omitted or set to 0 for a top-level category. The icon max-length and position ordering notes merely restate the schema, keeping it from a 5.

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 ('Create a category in the HelpCenter.io help center') and immediately situates it in the build workflow relative to helpcenter_create_article. An agent can distinguish it from helpcenter_update_category or helpcenter_list_categories without opening any schema.

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?

Gives explicit sequencing guidance ('create the categories first, then file articles into them with ... category_id') and a clear exclusion: privacy levels cannot be set here and must be changed in the dashboard. It stops short of naming update_category as the alternative for modifying existing categories, so it is clear context rather than full routing.

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