Skip to main content
Glama

Archive document

archive_document

Archive a document to remove it from collections while keeping it restorable from the archive. Use instead of permanent deletion.

Instructions

Archive a document (reversible; it disappears from the collection but can be restored from the archive). Prefer this over delete_document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDocument id

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.4

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does well: it discloses reversibility, the side effect of removal from the collection, and restorability from the archive. It does not mention permissions or whether archiving an already-archived document is idempotent, so it stops short of full disclosure.

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?

One sentence, zero filler, with the key semantic fact (reversible) surfaced immediately in parentheses and the routing advice last. Every clause earns its place.

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 one-parameter mutation tool with no annotations and no output schema, the description covers the essential behavior (reversible removal) and the sibling choice. Missing only peripheral details like permission requirements or the archive's subsequent retrieval path.

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 coverage is 100% and the single 'id' parameter is documented in the schema, so the description need not explain it. It adds no format hints or constraints beyond the schema, which is the baseline-3 case.

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 (Archive) and resource (document), and adds the semantic consequence: it disappears from the collection but is restorable. This distinguishes it from the update/delete family without needing a schema.

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?

Explicitly routes the agent: 'Prefer this over delete_document.' That is real when-to-use guidance. It loses a point because delete_document is not among the listed siblings and no when-not (e.g., when to genuinely delete instead) is stated.

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