Skip to main content
Glama

Rename Document

rename_document

Change a document's alias (doc_key). The canonical id never changes.

ref accepts the doc_… id or the current alias. The old alias keeps
resolving to the same document forever (alias_redirected warning) and is
never assigned to another 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": {
      "ref": "<ref>",
      "new_alias": "<new_alias>"
    },
    "name": "rename_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
refYes
new_aliasYes
idempotency_keyNoOptional. Retries with the same key and arguments within 24 h replay the first result (replayed=true) without a second write; a different body with the same key is idempotency_key_reused.
expected_versionNo
session_batch_idNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false and destructiveHint=false; the description adds genuinely new behavior — the old alias resolves forever, emits an alias_redirected warning, and is never reassigned. That is the key non-obvious trait of this mutation. It omits concurrency/versioning behavior, keeping it below 5.

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?

Two short paragraphs, front-loaded with the core verb and the invariant, with zero filler. Slightly fragmented by the mid-sentence line break in 'ref accepts…', but every sentence earns its place.

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?

An output schema exists, so return values need not be explained, and the key alias-redirect semantics are covered. However, for a non-read mutation with 5 parameters (including expected_version for optimistic concurrency), the description leaves important invocation context to the schema.

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 only 20%, so the description must compensate; it does add real meaning for 'ref' (id or alias) but says nothing about expected_version, session_batch_id, or new_alias constraints. The idempotency_key is already documented in the schema. Partial compensation only.

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?

States a specific verb and resource ('Change a document's alias (doc_key)') and clarifies the invariant that the canonical id is unchanged, which disambiguates it from supersede_document or archive_document. It does not explicitly name a sibling, so a 4 rather than a 5.

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 description explains that 'ref' may be an id or the current alias, which tells the agent how to invoke it, but it never states when to rename versus supersede/archive or what preconditions (e.g. concurrency via expected_version) apply. Usage is implied rather than directed.

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.