Skip to main content
Glama

Update document metadata

traceable_doc_update_meta
DestructiveIdempotent

Update a document's metadata: name, document number, document type, group, the numberedHeadings toggle, and its placement on the project's board (a cell's phaseId and workstreamId from traceable_board_read, or null to take it off the board). Placement changes no document content and opens no new draft. Turn numberedHeadings on so the app auto-numbers headings — then author heading text WITHOUT section numbers (see the headingNumbering note in traceable_capabilities). Only the fields you pass are changed. To change the TraceID prefix use traceable_doc_rename_prefix (it re-derives existing ids); it is not settable here.

Input Schema

NameRequiredDescriptionDefault
nameNoNew document name
groupIdNoMove to this group UUID, or null to ungroup
placementNoMove to this board cell (from traceable_board_read), or null to take it off the board
documentIdYesThe document UUID
documentTypeNoNew document type, or null to clear
documentNumberNoNew document number, or null to clear
numberedHeadingsNoTurn heading auto-numbering on or off

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / placement
      Added value: +{
      +  "anyOf": [
      +    {
      +      "properties": {
      +        "phaseId": {
      +          "description": "The cell's phaseId (from traceable_board_read)",
      +          "format": "uuid",
      +          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +          "type": "string"
      +        },
      +        "position": {
      +          "description": "Where in the cell, 0 being the top. Defaults to the end.",
      +          "maximum": 9007199254740991,
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "workstreamId": {
      +          "description": "The cell's workstreamId (from traceable_board_read)",
      +          "format": "uuid",
      +          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "phaseId",
      +        "workstreamId"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Move to this board cell (from traceable_board_read), or null to take it off the board"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations supply readOnly=false, destructiveHint=true, and idempotentHint=true, so the bar is lower; the description still adds useful non-obvious behavior: 'Only the fields you pass are changed' (partial-update semantics), 'Placement changes no document content and opens no new draft' (limits perceived blast radius), and the numberedHeadings auto-numbering side effect. It does not contradict destructiveHint, though it leaves the destructive nature of a metadata write somewhat implicit.

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?

Front-loaded with the field list, then constraints and sibling routing; every sentence carries information. Dense but slightly long, with parentheticals that could be tightened, keeping it short of a 5.

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 7-parameter mutation tool with no output schema, the description covers scope, partial-update behavior, placement sourcing, and the prefix alternative. It does not state whether a new revision/draft is otherwise triggered for content fields or what the response contains, but annotations carry safety and the absence of an output schema limits the obligation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3; the description goes beyond the schema by explaining that placement uses a cell's phaseId/workstreamId sourced from traceable_board_read and that null removes the document from the board, and by describing the practical workflow implication of numberedHeadings.

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?

States a specific verb (update) and resource (document metadata) and enumerates exactly which fields are in scope: name, number, type, group, numberedHeadings, and board placement. It explicitly names the sibling it is not (traceable_doc_rename_prefix for TraceID prefixes), so an agent can separate it from that tool 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 Guidelines5/5

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

Gives concrete when-to-use routing: use traceable_board_read to obtain placement ids, use traceable_doc_rename_prefix for prefix changes, and consult the headingNumbering note in traceable_capabilities. It also states a when-not condition ('it is not settable here') that prevents a common mis-invocation.

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