Skip to main content
Glama

Update an article

update_article
Destructive

MUTATES KnowledgeOwl data: updates an existing article. KnowledgeOwl API: PUT /article/{id}.json (JSON — only included fields change). Use the fields passthrough for current_version (title/body) and any other documented field. The path id is never sent in the body.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe article id to update (path only; required).
nameNoNew article name/title.
fieldsNoAdditional documented KnowledgeOwl fields to send in the JSON write body (e.g. current_version, body) — merged OVER the typed fields above.
statusNoNew publishing status.
url_hashNoNew URL slug.
visibilityNoNew visibility.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already indicate destructiveHint, and the description reinforces this with 'MUTATES' while adding non-obvious behavior: the API uses PUT with only-included-fields-change semantics, and the id is never sent in the request body. This goes beyond the bare annotation and helps the agent understand the operation's side effects.

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?

Three sentences, each with a distinct purpose: identify the operation, state the HTTP semantics, and clarify the two non-obvious parameter behaviors. No filler, no repetition of schema definitions.

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?

Combined with the exhaustive schema and destructiveHint annotation, the description covers operation type, endpoint, partial-update behavior, and the path/body split. It does not describe return values, but no output schema exists and the required parameter is already documented in the schema.

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%, so the baseline is 3, but the description adds meaningful parameter guidance: the `fields` passthrough is the correct way to send current_version/body, and it merges over typed fields. The note that id is path-only prevents a common invocation error.

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?

The description states a specific verb ('updates') and resource ('existing article'), and the leading 'MUTATES' clearly signals a write operation, distinguishing it from read/list/create siblings. The explicit endpoint further pins down the exact operation.

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?

The description makes clear this tool is for modifying an existing article, and the partial-update semantics ('only included fields change') convey when it is appropriate relative to create/get alternatives. It does not name sibling tools explicitly or state when not to use it, but the context is sufficiently obvious.

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.

TDQS

A3.8/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose targeting a specific resource (article, category, glossary, etc.) and action (create, get, list, update). There is no ambiguity or overlap between tool names.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern: create_X, get_X, list_X, update_X. The exception 'knowledgeowl_request' is a utility escape hatch, clearly marked, and does not break the overall pattern.

Tool Count4/5

At 24 tools, the set is slightly above the typical 3-15 range but still well-scoped for a knowledge base API covering many resources. Each tool serves a distinct purpose, and no tools are redundant.

Completeness2/5

The tool set lacks delete operations for all resources, and update operations are only available for articles and categories. Missing get tools for glossary terms, snippets, and other resources, though list tools are provided. This leaves significant gaps in lifecycle coverage.