Skip to main content
Glama

Traceable

by com.traceabledocs.app
OverviewDiscussionsAdmin

Rename document ID prefix

traceable_doc_rename_prefix
DestructiveIdempotent

Rename a document's TraceID prefix in place, rewriting every TraceID (traceable rows, native-table trace cells, and ID-grid id cells). Plain text and other rows without a TraceID are not changed, and the old prefix written as prose inside text is not rewritten. 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

NameRequiredDescriptionDefault
newPrefixYesNew prefix: 1–12 uppercase letters, digits, or hyphens (e.g. IQ-R)
documentIdYesThe document UUID
baseRevisionNoThe revision (meta.revision) from the traceable_doc_read, or the previous write, this change is based on. When given, the write is refused with nothing changed if the document has changed since, so you never overwrite edits you have not seen. Each write returns the current revision. The revision tracks the document's content rows, so changes that touch no row (its name and other metadata, the reference list, Test Plan entries) return it unchanged. A revision is an opaque value: compare it whole, never read meaning into its parts (they are not a counter).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / baseRevision
      Added value: +{
+  "description": "The revision (meta.revision) from the traceable_doc_read, or the previous write, this change is based on. When given, the write is refused with nothing changed if the document has changed since, so you never overwrite edits you have not seen. Each write returns the current revision. The revision tracks the document's content rows, so changes that touch no row (its name and other metadata, the reference list, Test Plan entries) return it unchanged. A revision is an opaque value: compare it whole, never read meaning into its parts (they are not a counter).",
+  "type": "string"
+}
  2. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Goes well beyond the annotations by enumerating exactly what is rewritten (traceable rows, native-table trace cells, ID-grid id cells) and what is not (plain text, other rows without a TraceID, prefix written as prose). It also states that trace links are preserved and that only human-readable ids change, plus the editable-draft requirement, giving the agent real mutation semantics for a destructiveHint=true tool.

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?

Four dense sentences with no filler, and the core action and its scope are front-loaded. Every clause earns its place, though the prose is on the heavier side for a two-required-param tool.

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 mutation tool with no output schema, it covers mutation scope, what is left untouched, link preservation, and the draft precondition, and the schema supplies the revision idiom. The only gap is the absence of sibling routing against traceable_trace_id_rename.

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 the schema already documents documentId, newPrefix (with format constraints), and baseRevision in detail. The description adds no parameter-level syntax or format meaning beyond the schema, so the baseline 3 applies.

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 (Rename) and resource (a document's TraceID prefix) and details the scope of the rewrite across traceable rows, native-table trace cells, and ID-grid id cells. It is clear what the tool does, but it never names or distinguishes itself from the sibling traceable_trace_id_rename, leaving that boundary to inference.

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 precondition (the document must be an editable draft; published documents are read-only) and an implicit alternative exclusion ("you do NOT need to recreate the document to re-prefix it"). It does not explicitly say when to pick this over traceable_trace_id_rename, so it stops short of full routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Traceable toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources