Skip to main content
Glama

Archive document

archive-document
DestructiveIdempotent

Archives a document, hiding it from the account's default document lists.

Use this tool when:

  • A document is no longer actively worked with and should be moved out of the way

  • The user asks to archive, hide, or clean up a document

Archiving does not delete anything: the document keeps all its data and can be restored later with the restore-document tool. The document must not already be archived.

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": {
      "document_uuid": "<document_uuid>"
    },
    "name": "archive-document"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_uuidYesUUID of the document to archive. If you don't already have the document's UUID, use the list-documents tool to find it.

Output Schema

NameRequiredDescriptionDefault
urlNoURL to open the document in fynk
nameNoName of the document
uuidNoUnique identifier for the document. Do not show to the user unless they ask for it
stageNoWhat stage the document is in currently
created_atNoWhen the document was created.
updated_atNoWhen the document was last updated.
archived_atNoWhen the document was archived. Absent when the document is not archived.
_entity_typeNoOnly relevant for tooling. Do not show to the user
document_typeNoIf present, indicates what kind of document this is. Absent when the document has no type assigned

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

The description adds important behavior beyond annotations: data is retained, the document can be restored later, and it must not already be archived. It does not cover permission requirements or how archiving affects other workflows, but the annotations already carry idempotency and destructive-hint information.

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?

The description is front-loaded with the core action and then uses a short bullet list for when to use it. Every sentence adds useful context without repeating the name or annotations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With full schema coverage, annotations, and an output schema, the description supplies the remaining behavioral context an agent needs: non-deletion, restorability, applicable scenarios, and the precondition. No material gap remains for correct invocation.

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?

The schema has 100% description coverage and already explains that document_uuid is the document UUID and suggests using list-documents if needed. The description adds no additional parameter-level syntax or format guidance, so the baseline of 3 is appropriate.

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?

The description states a specific verb and resource: archive a document and hide it from default document lists. It clearly distinguishes this from deletion and from the sibling restore-document tool, so an agent can select it without opening the 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?

It gives explicit use cases: documents no longer actively worked with, or user requests to archive, hide, or clean up. It also names the alternative restore-document and states the precondition that the document must not already be archived.

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