Skip to main content
Glama

Update Document Title & Metadata

update_document
Idempotent

Update a document's title, synopsis, notes, label, status, or custom fields in Scrivener. Pass only the fields to change; omitted fields remain unchanged.

Instructions

Update a document's title and/or its metadata (synopsis, notes, label, status, and custom fields) in a single call. Pass only the fields you want to change; omitted fields are left untouched. To change the body text use write_document; to move it use move_document. Requires an open project and a valid document id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
labelNoLabel name (e.g. a POV character or chapter color label).
notesNoDocument notes (the inspector Notes pane).
titleNoNew title for the document. Omit to leave the title unchanged.
statusNoStatus name (e.g. "To Do", "First Draft", "Done").
synopsisNoSynopsis / index-card text shown in the Scrivener outliner.
documentIdYesScrivener document UUID, as returned by get_structure (a binder item "id").
customMetadataNoMap of custom metadata field names to string values.
Behavior4/5

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

Annotations already indicate idempotent and non-destructive behavior. The description adds context that only specified fields are modified, reinforcing idempotence. No contradictions. Could mention response or side effects, but overall adequate.

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?

Three tightly written sentences. Each sentence serves a purpose: what it does, how to use it (partial updates), and when to use alternatives. No wasted words.

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?

Covers purpose, partial update behavior, prerequisites, and sibling differentiation. Lacks return value description, but for a mutation tool this is acceptable. Could be slightly more complete, but still strong.

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% with clear descriptions for each parameter. The description adds a general principle of partial updates, but this partly repeats the parameter-level notes (e.g., title 'Omit to leave unchanged'). Baseline 3 is appropriate; no significant extra meaning.

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 clearly identifies the verb ('update') and the resource ('a document's title and/or its metadata'), and explicitly distinguishes itself from sibling tools by directing body text changes to write_document and moves to move_document.

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

Usage Guidelines5/5

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

Provides explicit guidance on when to use it (metadata updates), what not to use it for (body text, moves), and prerequisites (open project, valid document id). Also explains partial updates: 'Pass only the fields you want to change; omitted fields are left untouched.'

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/writerslogic/scrivener-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server