Skip to main content
Glama

update_document

DestructiveIdempotent

Update a document's title or description by ID while leaving omitted fields unchanged. Preview changes first, then confirm to apply them.

Instructions

Update a document. Omitted fields stay unchanged.

Input Schema

NameRequiredDescriptionDefault
titleNoAt most 255 characters.
confirmNofalse: preview only, nothing changes. true: applies it; get the user's approval of the preview first.
descriptionNoDocument text; "" clears it.
document_idYesNumeric document id, as returned by list_documents.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.4

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is carried structurally. The description adds genuine value with the partial-update semantics (omitted fields unchanged), but says nothing about reversibility, permissions, or the destructive nature the annotations flag.

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?

Two short sentences, zero waste, with the core action and the key partial-update constraint front-loaded. Slightly thin rather than bloated, but structurally sound.

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 destructive mutation with no output schema, the description relies almost entirely on the schema for the confirm/preview workflow and parameter details. It is adequate but omits anything about side effects, concurrency, or what a successful update returns.

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%: the schema documents title length limits, the "" clears-text rule, the confirm preview/approval workflow, and the document_id source. The description adds only the general null-skip rule, so baseline 3 is appropriate.

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 document") and adds the partial-update rule ("Omitted fields stay unchanged"), which is clear enough to distinguish it from get_document/list_documents. It does not explicitly name a sibling alternative, so it falls 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?

There is no explicit when-to-use or when-not-to-use guidance, no mention of alternatives, and no prerequisites. The only directional hint is that unspecified fields are untouched, which is a behavioral rule rather than usage guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools