Skip to main content
Glama

Update Document Title

update_doc_title

Rename an AFFiNE document by updating both its sidebar title and internal page block title to keep workspace metadata and content consistent.

Instructions

Rename a document — updates both the sidebar title (workspace metadata) and the doc's internal page block title.

Input Schema

NameRequiredDescriptionDefault
docIdYesThe doc to rename.
titleYesNew title.
workspaceIdNo
expectedRevisionNoOptional read_doc revision of this primary document. Reject stale content before writing. Covers document content, not workspace metadata; requires all writers to share one MCP server.

Output Schema

NameRequiredDescriptionDefault
okNo
codeNo
kindNo
docIdNo
errorNo
titleNo
detailsNo
updatedNo
causeCodeNo
retryableNo
workspaceIdNo
recoveryGuidanceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.10.2

TDQS

A3.6/5.0
Behavior4/5

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

Beyond the annotations, the description discloses important behavior: the rename updates both workspace metadata and the document's internal page block title. That dual write is useful context not conveyed by readOnlyHint/destructiveHint. It does not discuss conflict behavior or stale revision handling, but the schema documents expectedRevision.

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 front-loaded sentence with no wasted words. It states the action and the two affected title locations efficiently.

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?

The tool is a simple mutation, and the description covers the key effect: both title locations are updated. Annotations and the schema cover safety, freshness checks, and parameter details, though the description could say more about the expectedRevision behavior.

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 75%, so most parameters are already documented in the schema. The description does not add parameter-specific guidance and only indirectly hints at workspace metadata. The undocumented workspaceId parameter is not compensated for in the description.

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 gives a specific verb and resource: 'Rename a document.' It also clarifies the dual target of the rename, updating both sidebar title and internal page block title. It is clear, though it does not explicitly differentiate itself from nearby tools such as update_block or update_doc_icon.

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?

The description states what the tool does but gives no guidance on when to use it versus alternatives. It does not mention prerequisites, related tools, or exclusions.

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