Skip to main content
Glama

Update a help article

update_article
Destructive

Change a help article: its title, description, Markdown body or status. Only the fields given change; the rest of the file stays as it was. Publishing makes it live in the help center and for the agent; "draft" unpublishes it. Every save adds a version that restore_article_version can bring back. An article stays in its collection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoThe whole new body in Markdown, without front matter.
slugYesThe article slug, including its collection, e.g. "billing/download-invoices" (from list_articles).
titleNoA new title.
statusNodraft: hidden from visitors and the agent. published: live in the help center and used by the agent. archived: retired, hidden, kept with its history.
productIdYesProduct id from list_products.
descriptionNoA new one-line description; empty clears it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations, it discloses real behavioral traits: partial-update semantics, the fact that publishing makes content live for both visitors and the agent, that 'draft' unpublishes, that every save adds a restorable version, and that collection membership is fixed. It does not explain permission/auth requirements or confirm the destructive implication (published content going offline) that destructiveHint=true raises, so it stops short of full disclosure.

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 core action in the first clause, then layers in only high-value facts: partial-update behavior, publish/unpublish effect, versioning, and fixed collection. Five short sentences, each earning its place, with no redundancy.

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

Completeness4/5

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

For a destructive, non-idempotent mutation with six parameters and no output schema, the description covers update semantics, publish side effects, and recoverability well. It leaves open permission requirements and error/failure behavior, but for a partial-update tool the essentials an agent needs to invoke it are present.

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%, so the schema already documents all six parameters including the status enum and slug format. The description restates which fields are updatable but adds no format, constraint, or edge-case detail (e.g. productId/slug scope) beyond what the schema provides. Baseline 3 is appropriate.

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 (change/update) plus resource (help article) and enumerates the mutable fields (title, description, Markdown body, status). It also distinguishes behavior from nearby siblings by naming restore_article_version and clarifying the article cannot be moved between collections, so an agent can tell it apart from create_article or move-style tools.

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 clear context: partial-update semantics ('only the fields given change'), the meaning of publishing vs draft for the help center and the agent, and the fact that each save creates a restorable version. It stops short of explicit when-to-use/when-not rules against siblings like archive_article, which also sets the archived state, leaving some overlap to inference.

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