Skip to main content
Glama

update_help_center_article

Update a Help Center article, synchronizing changes to the bot's RAG vector memory.

Input Schema

NameRequiredDescriptionDefault
slugNo
tagsNo
titleNo
bot_idYes
statusNo
contentNo
subtitleNo
article_idYes
visibilityNo
category_idNo
is_promotedNo
order_indexNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose one genuinely useful side effect: the RAG vector memory is re-synced. It does not say whether partial updates are supported (all 10 fields are optional natively), whether omitting a field leaves it unchanged or clears it, whether permissions are required, or whether the RAG sync is immediate or asynchronous.

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?

A single front-loaded sentence with the key side effect attached; nothing is wasted. Its brevity is only a problem because more needed to be said, which is captured elsewhere.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 12-parameter mutation with no annotations, no output schema, and zero schema descriptions, the description is far too thin. An agent would not know update semantics, permission prerequisites, or the effect on the published article versus its RAG index.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 12 parameters, so the description must compensate, and it says nothing about any parameter. No meaning is given for article_id/bot_id pairing, the visibility or status value spaces, or which fields are patchable.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (update a Help Center article) and adds a distinguishing trait: changes propagate to the bot's RAG vector memory. It is clearly separable from create_help_center_article / delete_help_center_article siblings, though it does not say what an 'update' can touch.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No indication of when to use this versus create_help_center_article, update_help_center_category, or the knowledge-sync tools. The only implied guidance is that the article must already exist, which the agent must infer from the verb.

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