Skip to main content
Glama

Update KB document

update_kb_document
Destructive

Update the title, category, content or source URL of a knowledge base document. Re-ingestion runs after the change.

Input Schema

NameRequiredDescriptionDefault
titleNo
contentNo
categoryNo
source_urlNo
document_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true, so the safety profile is covered. The description adds a genuinely non-obvious side effect, 'Re-ingestion runs after the change,' which is exactly the kind of extra context that earns credit under the lower annotated bar. It stops short of 5 because it doesn't say whether omitted fields are preserved (partial vs. full replace).

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 short sentences, front-loaded with the mutability scope followed by the side effect. Every clause earns its place with no filler.

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

Completeness3/5

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

For a 5-parameter mutation tool with no output schema and 0% schema coverage, the description is adequate on the side-effect front but thin elsewhere: partial-update semantics, permissions, and any field constraints are left unaddressed.

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 0%, so the schema itself carries no parameter meaning. The description names four of the five parameters as the updatable fields (title, category, content, source URL), which partially compensates, but it gives no format, enum values or constraint detail and never mentions document_id.

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 (Update) plus resource (knowledge base document) and enumerates the mutable fields, which cleanly separates it from create_kb_document, delete_kb_document and reingest_kb_document. It never explicitly names those siblings, so it stops just short of a 5.

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 'when to use this vs. alternative' guidance is given. The closest thing is the note that re-ingestion runs after the change, which implies a relationship to reingest_kb_document but does not tell the agent when to pick which.

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