Skip to main content
Glama
Sign In

HelpCenter.io

by io.helpcenter
OverviewDiscussionsAdmin

Update HelpCenter Category

helpcenter_update_category
DestructiveIdempotent

Update an existing category by id in the connected HelpCenter.io help center.

Partial update — only fields you pass change. Requires a write-scoped API key. Name and description are per-language objects keyed by language code.

Args:

  • category_id (number, required): id of the category to update.

  • name (object, optional): per-language category name.

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

  • parent_id (number, optional): id of the parent category for nesting (must belong to this site). Use 0 to make the category top-level.

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

  • position (number, optional): sibling order, ascending. To move several categories at once use helpcenter_reorder_categories instead.

Returns: { status: "success", category: {...} } with the updated category.

Errors: 403 if the key is read-scoped; 404 if the category id is not in this help center; 422 for unsupported language codes, an invalid parent_id, or a parent that would make the tree a loop (a category cannot be its own parent or a descendant's child).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "category_id": "<category_id>"
    },
    "name": "helpcenter_update_category"
  }
}

Input Schema

NameRequiredDescriptionDefault
iconNoIcon identifier for the category (max 190 chars).
nameNoPer-language category name.
site_idNoWhich help center to act on: an id from helpcenter_list_sites. Needed when this connection reaches more than one help center; omit it when it reaches one. Applies to this call only — pass it on every call of a task, and ask the user which help center they mean if their request does not say.
positionNoSibling order, ascending. Only comparable within one parent. 0 puts the category first.
parent_idNoId of the parent category (for nesting). Must belong to this site.
category_idYesId of the category to update.
descriptionNoPer-language category description.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations cover the safety profile (destructiveHint, idempotentHint, openWorldHint), and the description adds materially more: write-scoped key requirement, partial-update semantics, a concrete return shape, and the 403/404/422 failure modes including the tree-loop constraint on parent_id.

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 and partial-update semantics, then Args and Errors blocks that are easy to scan. The Args list largely restates a fully covered schema, so some redundancy remains, but nothing is wasted or buried.

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 7-parameter mutation with no output schema, the description supplies return shape, error conditions, ordering semantics, and nesting rules — everything an agent needs to invoke it correctly without guessing.

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%, yet the description still adds meaning the schema does not: parent_id=0 means top-level, position is sibling order with a pointer to reorder_categories, and name/description are per-language objects keyed by language code. The notable gap is that site_id is not mentioned in the Args list at all.

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 ("Update an existing category by id") scoped to "the connected HelpCenter.io help center," which cleanly separates it from create_category, delete_category, and reorder_categories in the sibling list.

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?

Explicitly frames the call as a partial update ("only fields you pass change") and routes multi-category repositioning to helpcenter_reorder_categories instead. It lacks an explicit statement of when not to use it (e.g. for bulk edits or staging workflows) but the context is otherwise clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All HelpCenter.io toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources