Skip to main content
Glama

update_document

Update an existing document (doc, word, note). Supply a new title and/or HTML content to replace the body.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDocument ID
titleNoNew title
contentNoNew HTML content (replaces entire document body)

Schema Changelog

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

  1. First observed

TDQS

A3.6/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does state that content replaces the entire document body, but this is also already documented in the input schema's property description. The description does not mention permissions, reversibility, side effects, or what happens to other fields when only title or content is supplied. This is a significant gap for a mutation tool.

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?

The description is a single sentence of 17 words, immediately front-loading the verb and object. It includes the essential scope ('doc, word, note') and the key action ('replace the body') with no filler or redundant phrasing. Every part earns its place.

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?

Given the tool's simplicity (3 parameters, no output schema) and the strong schema coverage, the description is largely sufficient. It covers the core update capability and the destructive nature of content replacement. It could mention that id is required and other fields are optional, but this is already clear from the schema. Overall, it is complete enough for an agent to use correctly.

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 coverage is 100%, so the baseline is 3. The description adds the 'and/or' qualifier, indicating that a call can include title, content, or both, which is a useful usage pattern not explicitly stated in the schema. However, the schema already provides clear descriptions for each parameter (e.g., 'New HTML content (replaces entire document body)'), so the description's additional value is marginal.

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 the specific verb 'Update' and the resource 'existing document', further distinguishing it as handling doc, word, and note types. This clearly differentiates it from sibling tools like update_sheet or update_slide_presentation. The additional clause about supplying title and/or HTML content to replace the body further clarifies the tool's scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by mentioning 'existing document', which signals this is for modifying already-created documents rather than creating new ones. However, it lacks explicit when-to-use or when-not-to-use guidance and does not name any alternative tools (e.g., create_document or delete_document). The context is clear but not fully explicit.

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

Each tool maps to a distinct resource and action: documents, sheets, slides, and servers. Even similar operations like update_sheet and update_sheet_tab are clearly separated by scope (workbook vs tab).

Naming Consistency4/5

Most tools follow a verb_noun pattern (create_document, delete_sheet_tab, list_slides), but there are minor deviations: 'append_to_document' vs 'append_rows'/'append_slides', and 'create_slide_presentation' vs 'list_slides' use inconsistent naming lengths and pluralization.

Tool Count4/5

With 23 tools, the server is slightly above the ideal 3–15 range but reasonable for covering three full document-type lifecycles (documents, spreadsheets, presentations) plus server listing. No tool feels redundant.

Completeness4/5

The server provides create, read, update, delete, list, and append operations for documents, sheets, and presentations, including tab-level management for spreadsheets. Minor gaps exist like no individual slide update or search across all resource types, but the core workflows are well-covered.

Resources