Skip to main content
Glama

Traceable

Rename document ID prefix

traceable_doc_rename_prefix
DestructiveIdempotent

Rename a document's TraceID prefix in place, re-deriving every existing row's visible id (traceable rows, native-table trace cells, and ID-grid id cells). Trace links are preserved — only the human-readable ids change — so you do NOT need to recreate the document to re-prefix it. The document must be an editable draft (published documents are read-only).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
newPrefixYesNew prefix: 1–12 uppercase letters, digits, or hyphens (e.g. IQ-R)
documentIdYesThe document UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations declare the safety profile (destructive, idempotent, not read-only), but the description adds genuinely useful context the annotations cannot convey: the exact scope of the rewrite, that trace links are preserved while only visible ids change, and the draft-only prerequisite. It does not describe failure modes such as prefix collisions or uniqueness constraints.

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 sentences, front-loaded with the action and effect, followed by the 'no need to recreate' reassurance and the prerequisite. No filler and every clause carries information an agent needs.

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?

For a destructive, non-read-only mutation with no output schema, the description covers scope, side effects on descendant rows, preservation of links, and eligibility. The main omission is any indication of what the caller gets back or how many rows are affected.

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%, with the newPrefix format and documentId UUID pattern fully documented in the schema, so the baseline is 3. The description adds only the conceptual note that the prefix is the human-readable portion of the id, no syntax or constraint detail beyond the schema.

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 ('Rename a document's TraceID prefix in place') and enumerates what gets rewritten (traceable rows, native-table trace cells, ID-grid id cells). However, it never distinguishes itself from the sibling traceable_trace_id_rename, which an agent could easily confuse with this tool.

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?

Gives a clear when-to-use rationale ('you do NOT need to recreate the document to re-prefix it') and an explicit when-not via the prerequisite 'The document must be an editable draft (published documents are read-only).' It stops short of naming an alternative tool for the published-document case.

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.

Resources