Skip to main content
Glama

update_document

Replace a document's Markdown content, rename it, or move it to a new parent or teamspace.

Instructions

Replace content (Markdown), rename or move a document

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace": "<workspace>",
      "documentId": "<documentId>"
    },
    "name": "update_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNo
markdownNoNew body (replaces content)
parentIdNoMove under this document; null = top level
workspaceYes
documentIdYesDocument id
teamspaceIdNoMove to this teamspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.5.1

TDQS

A3.5/5.0
Behavior3/5

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

The description does disclose that content is overwritten ('Replace content'), which is meaningful behavior beyond the annotations. However, with only destructiveHint=false and a title in the annotations, it omits whether omitted fields are preserved, whether the operation is partial or full replacement, and what permissions are needed.

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?

A single short clause with the operation types front-loaded and no filler. It is terse to the point of under-specification but every word carries information.

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 six-parameter mutation tool with no output schema and minimal annotations, the description covers the what but leaves partial-update semantics and the role of workspace unaddressed. It is adequate but not fully self-sufficient.

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 67%, and the description maps its verbs onto parameters: 'content (Markdown)' to markdown, 'rename' to title, 'move' to parentId/teamspaceId. That mapping adds a useful mental model beyond the raw schema, though workspace stays unexplained.

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 names a specific verb and resource and enumerates the three mutations it performs: replacing Markdown content, renaming, and moving. That clearly separates it from create_document, get_document, and delete_document, though it doesn't explicitly name a sibling.

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 phrase 'Replace content, rename or move' implies the applicable scenarios but gives no explicit when-to-use versus alternatives, no prerequisites such as required permissions, and no note on whether title and markdown can be supplied independently.

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