Skip to main content
Glama

Update document

update_document
Destructive

Update a document's name and/or content. Omit a field to leave it unchanged.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNo"dbml" for a database schema (the default), "mermaid" for a diagram. Name the file to match: .dbml for a schema, .mmd for a diagram.
nameNoNew file name; omit to keep it.
docIdYesDocument id (uuid).
orderNoNew sort position; omit to keep it.
contentNoReplacement document text; omit to keep it.
projectIdYesProject id (uuid).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
kindYes
nameYes
orderNo
contentYes

TDQS

B3.3/5.0
Behavior3/5

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

With destructiveHint=true already signaling mutation, the description adds useful partial-update semantics: 'Omit a field to leave it unchanged.' It does not expand on irreversibility, permissions, or the fact that content replacement is a full overwrite, but annotations lower the burden.

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?

A single, front-loaded sentence that immediately communicates the operation and the key partial-update behavior. No wasted words.

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?

The description is minimally adequate for a simple update operation, but it leaves gaps: it does not mention that kind and order are also updatable, and it gives no routing information relative to reorder_documents or delete_document. The output schema and annotations cover some other context, lowering the burden on the description.

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 parameters are already well documented. The description's 'omit a field' guidance adds a small layer of meaning, but it also omits two updatable fields (kind and order), reducing its value as a summary.

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?

The description states a clear action and resource: 'Update a document's name and/or content.' This distinguishes it from create_document and delete_document at a basic level. However, it mentions only name and content while the schema also allows updating kind and order, so the stated scope is incomplete.

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 guidance is given about when to choose this tool over siblings like reorder_documents or delete_document. The only usage hint is 'Omit a field to leave it unchanged,' which addresses parameter semantics rather than tool selection.

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.7/5.0
Disambiguation5/5

Every tool targets a distinct resource/action: board retrieval is split into JSON vs image with explicit cross-references, and drawing tools are separated from the generic update_board. Look-alikes like list_documents vs list_diagrams and publish_listing vs use_template are differentiated clearly.

Naming Consistency4/5

Most tools follow a verb_noun pattern: create_project, list_documents, update_board, upsert_org_member. A few noun-only names like my_listings, project_file_counts and template_categories break the pattern, so naming is consistent but not uniform.

Tool Count2/5

40 tools is well beyond the 25+ threshold for a single server, even though the domains are clustered into org/project/document/board/template areas. The large surface will make tool selection and onboarding heavier for an agent than necessary.

Completeness3/5

Core lifecycle coverage for org/project/document/board/template is mostly present, and update_board serves as a flexible escape hatch. However, the board API reads rectangle/diamond/ellipse/free-text drawings and groups/links but only offers explicit create/erase for strokes and arrows; paid template purchase/access is also left unclear.

Resources