Skip to main content
Glama

Supersede Document

supersede_document
Destructive

Mark old_doc_key superseded by new_doc_key: both get a new version, and 2026-11 queries hide the old one unless include_lifecycle names superseded.

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": {
      "old_doc_key": "<old_doc_key>",
      "new_doc_key": "<new_doc_key>"
    },
    "name": "supersede_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
reasonNo
new_doc_keyYes
old_doc_keyYes
new_namespaceNodefault
old_namespaceNodefault

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false and destructiveHint=true; the description adds genuinely non-obvious behavior: both documents receive a new version, and the old one is hidden from default queries unless include_lifecycle names superseded. It does not say whether this is reversible (e.g., via restore_document) or what happens to the previous version chain.

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?

One dense sentence with no filler, and the core action is front-loaded before the query-visibility caveat. Slightly overloaded with the parenthetical query-behavior clause, but no waste.

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 needn't be described, and the lifecycle effect is covered. However, for a destructive five-parameter mutation with zero schema documentation, leaving namespaces and reason unexplained leaves the definition short of complete.

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

Parameters2/5

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

Schema coverage is 0% across five parameters, and the description explains only old_doc_key and new_doc_key. The reason, old_namespace, and new_namespace parameters are undocumented anywhere, and 'include_lifecycle' is mentioned but is not a parameter of this tool, which may confuse the agent.

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?

The description gives a specific verb ('Mark ... superseded') plus both key resources, and explains the resulting state change ('both get a new version'). This clearly separates it from rename_document or archive_document, though it never names a sibling explicitly.

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?

Usage is implied by the operation itself — supersede when a document is replaced by another — and the note about 2026-11 queries reveals the downstream effect. There is no explicit when-not guidance or named alternative (e.g., use rename_document vs archive_document instead).

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.