Skip to main content
Glama

Put a document away, or bring it back

archive_doc
Idempotent

Put a document or one page away when the person asks, or bring it back with archived false; nothing is deleted or changed («delete it» is flag_doc).

Instructions

Put a document or one page away when the person asks, or bring it back with archived false; nothing is deleted or changed («delete it» is flag_doc). A page put away stays under its document, read-only; a document's pages go and come back with it.

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": "<doc>"
    },
    "name": "archive_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
docYesThe document's id from `docs`, not its title
folderNoA folder to file it in on the way, by name, path or id
archivedNoTrue, the default, puts it away

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.47.1
    • changedInput schema / properties / archived / description
      Previous value: -"True, the default, puts it away; false brings it back"New value: +"True, the default, puts it away"
  2. Changed3 schema fields changedv1.43.2
    • changedInput schema / properties / archived / description
      Previous value: -"True to put it away, which is what happens if you leave this out; false to bring it back"New value: +"True, the default, puts it away; false brings it back"
    • changedInput schema / properties / doc / description
      Previous value: -"The document's id, as `docs` hands it back — an opaque name like `q7ntmzbm-0001`, not its title"New value: +"The document's id from `docs`, not its title"
    • changedInput schema / properties / folder / description
      Previous value: -"A folder to file it in as it goes, or as it comes back, by its name, its whole path or its id. It is filed either way: what the archive holds can still be put where it belongs"New value: +"A folder to file it in on the way, by name, path or id"
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Adds real behavior beyond the annotations: nothing is deleted or changed, an archived page stays under its document in a read-only state, and a document's pages archive and restore together with it. That cascade and reversibility context is exactly what the description alone can supply. It stops short of stating permission requirements or what happens to the `folder` argument on restore, so not a 5.

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?

Two sentences, front-loaded with the primary action and reverse action before the guard-rail about deletion. Slightly dense with parenthetical asides and mixed quoting styles, but nothing is redundant.

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 non-destructive, idempotent mutation with no output schema and fully documented parameters, the description covers reversibility, cascade scope, and the delete-vs-archive confusion. Only edge behavior on the optional `folder` argument and post-call state reporting are left implicit.

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%, so all three parameters are already documented, and the description mostly restates the `archived` default/restore semantics the schema implies. The third parameter `folder` is never mentioned in the description, so no meaning is added over the schema there. Baseline 3 is appropriate when the schema does the work.

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 and resource ('Put a document or one page away ... or bring it back') and explicitly contrasts itself with the sibling `flag_doc` for deletion. An agent can distinguish archive from delete purely from the description, without consulting any 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 the trigger ('when the person asks'), the inverse operation (`archived` false), and an explicit exclusion routing destructive intent to `flag_doc`. This is the when/when-not/alternative triad at full strength.

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