Skip to main content
Glama

Rename Doc

update_doc
Destructive

Update the title of the specified accessible Doc. Use edit_doc_content for body changes. Preserve requestId on retries.

Input Schema

NameRequiredDescriptionDefault
idYesExisting target ID returned by the matching list, read or search tool. Preserve any search type prefix. Do not invent IDs.
titleYesDoc title requested by the user.
requestIdYesA unique UUID for this intended action. Reuse it unchanged when retrying the same action.

Output Schema

NameRequiredDescriptionDefault
docYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=false, so the mutation/idempotency profile is covered. The description adds retry guidance ('Preserve requestId on retries') and permission framing ('accessible'), but never says the previous title is overwritten irreversibly — the key destructive consequence. Moderate added value over annotations.

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 short sentences, no filler, with the core action front-loaded and the routing hint immediately after. Every sentence 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?

An output schema exists, so return values need not be explained, and annotations carry the safety profile for this mutation. The one gap is the absence of any statement about what happens to the existing title or permission failures, which for a destructive-headlined tool would be worth a clause.

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 id, title, and requestId are fully documented in the schema, including the retry semantics the description repeats. The description adds nothing the schema does not already say about parameters; baseline 3 applies.

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 a specific verb+resource+scope: 'Update the title of the specified accessible Doc.' This differentiates it cleanly from create_doc (creation), get_doc (read), and edit_doc_content (body edits), which it names explicitly.

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

Usage Guidelines4/5

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

It gives a clear routing rule: use this tool for title changes, use edit_doc_content for body changes. That is explicit when-to-use guidance with a named alternative. It stops short of stating exclusions (e.g. locked/trashed docs) beyond the word 'accessible'.

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.