Skip to main content
Glama
Sign In

HelpCenter.io for agents

by io.helpcenter
OverviewDiscussionsAdmin

Reorder Articles In A HelpCenter Category

helpcenter_reorder_category_articles
DestructiveIdempotent

Set the reading order of the articles inside one category.

Requires a write-scoped API key.

Args:

  • category_id (number, required): the category whose articles are being ordered.

  • articles (array, required): the articles in the order you want them, as [{ id }] or [{ id, position }]. Omit 'position' on an entry and it takes its place in the list.

CHECK 'order_visible' IN THE RESPONSE. A help center only displays this order when its category pages are set to sort articles by "Custom"; under any other sort the order is stored but never shown, and the call still succeeds. The response reports order_visible (boolean), article_sort (the sort actually in effect) and, when it is not custom, a 'hint' naming the setting to change. This tool deliberately does not change that setting for you — on a Template Editor v2 site that would mean publishing the site's template, shipping whatever unfinished design edits the customer had open.

Articles you do not list are left where they are. Ids that are not in the category are returned in skipped_article_ids rather than silently written.

Returns: { status: "success", updated_count, skipped_article_ids, order_visible, article_sort, article_sort_source, hint }.

Errors: 403 if the key is read-scoped; 404 if the category is not in this help center.

Input Schema

NameRequiredDescriptionDefault
articlesYesThe articles in the order you want them. Omit `position` on an entry to use its place in the list. Ids that are not in this category are reported as skipped.
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.
category_idYesId of the category whose articles are being ordered.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Goes well beyond the annotations: discloses the auth requirement (write-scoped key, 403 otherwise), the partial-write behavior (unlisted articles stay put, unknown ids returned in skipped_article_ids rather than written), the deliberate refusal to touch the sort setting, and the 404 condition. That is exactly the mutation-side-effect disclosure a destructive tool needs.

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 the core action, then the critical visibility caveat in caps, then args, returns and errors. Dense but each block carries information; the Args block is the only partly redundant section.

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 compensates by enumerating the response fields (updated_count, skipped_article_ids, order_visible, article_sort, hint) and the error cases. An agent has everything needed to call it and interpret the result, including the trap where the call succeeds but the order is never displayed.

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%, and the Args section mostly restates what the schema already documents for category_id, articles and position. It does reinforce the omit-position semantics, but adds little genuinely new meaning beyond the structured fields, so 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?

States a specific verb and resource with scope: 'Set the reading order of the articles inside one category.' That is clearly distinct from the sibling helpcenter_reorder_categories, which operates on categories rather than articles.

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 strong contextual guidance: it explains the prerequisite (write-scoped key), the condition under which the result is actually visible ('Custom' article sort), and explicitly states the tool will not change that setting and why. It does not name a sibling tool to use instead, but the domain distinction from reorder_categories is obvious.

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

All HelpCenter.io for agents 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