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.

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": {
      "requestId": "<requestId>",
      "id": "<id>",
      "title": "<title>"
    },
    "name": "update_doc"
  }
}

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?

The annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is known. The description adds two pieces of genuinely useful context — that the target must be 'accessible' and that requestId must be reused unchanged on retries — but it never discloses that the prior title is overwritten and unrecoverable, which is the behavior an agent most needs to confirm against destructiveHint=true. Adequate, with a notable gap.

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?

Two short sentences, each doing distinct work: the first states scope, the second handles the sibling alternative, and a trailing clause covers retry semantics. Nothing is padded and the core purpose is front-loaded.

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?

With three fully documented parameters, an output schema, and rich annotations, the description needs only to supply purpose, routing, and retry behavior — all of which it does. The only missing element an agent might want is confirmation that the previous title is replaced rather than versioned.

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%, and the schema already explains the id pattern, prefix preservation, and the requestId retry contract in detail. The description's 'specified accessible Doc' and 'Preserve requestId on retries' largely restate what the parameter descriptions already say, so it adds little beyond the baseline.

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 names a specific verb and resource ('Update the title of the specified accessible Doc') and immediately separates this tool from its nearest sibling by scoping the change to the title only. An agent can tell this apart from edit_doc_content without opening either schema.

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 explicitly routes body edits to edit_doc_content, which is the key sibling decision an agent has to make. It stops short of stating prerequisites such as edit permissions or what happens if the doc is not accessible, but the primary alternative is covered.

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.