Skip to main content
Glama

create_help_center_article

Create and publish a Help Center article. Automatically trains the bot's RAG memory so the AI assistant can reference it in chat.

Input Schema

NameRequiredDescriptionDefault
slugNo
tagsNo
titleYes
bot_idYes
statusNopublished
contentYes
subtitleNo
visibilityNopublic
category_idNo
is_promotedNo
order_indexNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It usefully discloses a non-obvious side effect: the article automatically trains the bot's RAG memory. It does not state whether the operation requires specific permissions, whether re-creating duplicates existing articles, how the default visibility of 'public' affects exposure, or what the response contains.

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?

Two sentences with no filler, and the core action is front-loaded before the side-effect context. Every sentence earns its place.

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 an 11-parameter creation tool with no annotations, no output schema, and 0% parameter description coverage, the description does too little. It should at minimum explain the status, visibility, and category/slug semantics that materially affect the created article, and note the RAG training implications in more detail.

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?

The schema has 11 parameters with 0% description coverage, and the description explains none of them: no mention of slug, tags, status, visibility, subtitle, category_id, is_promoted, or order_index. 'Create and publish' only loosely hints at the status parameter. With so many undocumented parameters and defaults that materially affect behavior, the description fails to compensate for the schema gap.

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?

Clearly states a specific verb and resource: 'Create and publish a Help Center article.' This distinguishes it from sibling mutation tools like update_help_center_article and creation tools for other resources such as create_help_center_category. The only slight ambiguity is 'publish,' since status defaults to published but could also be a draft.

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

Usage Guidelines3/5

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

The second sentence implies the use case: create an article so the AI assistant can reference it in chat. However, there is no explicit guidance on when to use this versus update_help_center_article, no mention of prerequisites like bot_id or category_id, and no note that status can be set to non-published.

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