Skip to main content
Glama

Archive Document

archive_document
Destructive

Soft-archive a document (creator or workspace commander only).

Archived documents disappear from ordinary list/query/map results but can
still be dereferenced for audit and listed with include_archived=true.

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": {
      "doc_key": "<doc_key>"
    },
    "name": "archive_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
reasonNo
doc_keyYes
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

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Annotations declare destructiveHint=true, and the description adds exactly the context that tempers it: the archive is soft, documents vanish from ordinary list/query/map results but remain dereferenceable for audit and visible via include_archived=true. That is precisely the reversibility and visibility information an agent needs before mutating, over and above the structured hints.

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?

Two short sentences, front-loaded with the action and its authorization gate, followed by the consequences. Nothing is padded and no sentence could be dropped without losing information.

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?

An output schema exists, so return values need not be explained, and the description covers authorization and post-archive visibility well. It falls short only on parameter semantics — notably the optimistic-concurrency meaning of expected_version — for a destructive mutation where a stale-version failure is a likely agent error.

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 description coverage is only 25%: idempotency_key is documented inline, but doc_key, reason, and expected_version carry no explanation anywhere. The description does not compensate at all — it never mentions concurrency control via expected_version or what a reason is used for, so three of four parameters remain semantically opaque.

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?

"Soft-archive a document" is a specific verb+resource, and the qualifier "soft" plus the visibility effects distinguish it clearly from hard-delete or supersede operations in the sibling list. An agent can tell this apart from restore_document and supersede_document 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 Guidelines3/5

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

The parenthetical "(creator or workspace commander only)" gives a useful authorization precondition that tells the agent whether it can call this at all. However, there is no explicit guidance on when to archive versus supersede_document, and no mention that restore_document is the inverse operation, so the alternative-selection reasoning is only implied.

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.