Skip to main content
Glama

Archive document

archive-document
Destructive

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.

Input Schema

TableJSON 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

TableJSON 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.7/5.0
Behavior5/5

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

Goes well beyond the destructiveHint/readOnlyHint/openWorldHint annotations by disclosing that nothing is deleted, all data is retained, the action is reversible via restore-document, and that an already-archived document is a precondition failure. This reconciliation of 'destructive' annotation with a reversible operation is exactly the kind of context annotations cannot convey.

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?

Front-loaded single-sentence definition, then compact bulleted triggers, then a short behavioral clause. Every sentence earns its place with no repetition of the schema 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?

For a one-parameter state-change tool with an output schema (so return values need no explanation), the description supplies preconditions, alternatives, reversibility, and data-retention behavior. Nothing material for correct invocation is missing.

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 description coverage is 100% and the single parameter's schema description already explains what the UUID is and points to list-documents for discovery. The body text adds no further parameter detail, so the baseline 3 applies.

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 (archives) and resource (document) plus the observable effect (hiding it from the account's default document lists), which lets an agent distinguish it from siblings like move-document-to-done-stage and restore-document without opening 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 Guidelines5/5

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

Explicitly enumerates when to use it ('no longer actively worked with', 'user asks to archive, hide, or clean up'), names the inverse operation (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