Skip to main content
Glama

archive_document

DestructiveIdempotent

Archive documents to remove them from active collections while preserving searchability for future reference.

Instructions

    Archives a document to remove it from active use while preserving it.

    IMPORTANT: Archived documents are removed from collections but remain
    searchable in the system. They won't appear in normal collection views
    but can still be found through search or the archive list.

    Use this tool when you need to:
    - Remove outdated or inactive documents from view
    - Clean up collections while preserving document history
    - Preserve documents that are no longer relevant
    - Temporarily hide documents without deleting them

    Args:
        document_id: The document ID to archive

    Returns:
        Result message confirming archival
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Beyond annotations (destructiveHint, idempotentHint), the description adds critical context: archived documents are removed from collections but remain searchable, and they don't appear in normal views. This explains the behavioral traits clearly.

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?

The description is well-structured with a purpose statement, a bullet list of behavioral effects, and a list of use cases. While slightly long, it is front-loaded and every sentence adds value. Could be slightly more concise but effective.

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 simple tool with one parameter and an output schema (indicated as present), the description covers purpose, behavior, usage, parameter, and return value. It is complete given the tool's complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter 'document_id' is described as 'The document ID to archive,' providing essential context beyond the schema's title. With 0% schema description coverage, this brief description compensates adequately.

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 clearly states 'Archives a document to remove it from active use while preserving it,' using a specific verb and resource. It distinguishes from siblings like 'delete_document' (permanent removal) and 'unarchive_document' (reverse action), and 'batch_archive_documents' (bulk operation).

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?

The description explicitly lists when to use this tool with four specific scenarios: removing outdated documents, cleaning up collections, preserving history, and temporarily hiding. It provides clear context compared to alternatives like deleting or unarchiving.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Vortiago/mcp-outline'

If you have feedback or need assistance with the MCP directory API, please join our Discord server