Skip to main content
Glama

batch_archive_documents

DestructiveIdempotent

Archive multiple documents in a single operation to remove them from collections while keeping them searchable.

Instructions

Archives multiple documents in a single batch operation.

This tool processes each document sequentially, continuing even if individual operations fail. Rate limiting is handled automatically by the Outline client.

IMPORTANT: Archived documents are removed from collections but remain searchable. 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:

  • Archive multiple outdated documents at once

  • Clean up collections in bulk

  • Batch hide documents without deleting them

Recommended batch size: 10-50 documents per operation

Args: document_ids: List of document IDs to archive

Returns: Summary of batch operation with success/failure details

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Discloses sequential processing, continues on failure, automatic rate limiting, and the effect on documents (removed from collections but remain searchable). Annotations (destructiveHint: true, idempotentHint: true) are consistent and description adds significant behavioral context beyond them.

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?

Well-structured with short paragraphs, bullet points, and clear sections. Every sentence adds value; no fluff. Front-loaded with purpose and behavior.

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?

Given the simple operation (1 param, basic archiving), the description fully covers purpose, behavior, usage, and return type. Output schema exists to detail return values. No gaps.

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?

Only one parameter (document_ids). Schema description coverage is 0%, but description repeats 'List of document IDs to archive' which adds little beyond the schema. No details on format, limits, or constraints for the array items.

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?

Clearly states it archives multiple documents in a batch, distinguishing from siblings like archive_document (single) and batch_delete_documents (deletion vs archive). Specific verb+resource: 'batch archive documents'.

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?

Provides explicit use cases (archive multiple outdated docs, clean collections, batch hide) and a recommended batch size. Lacks explicit when-not-to-use or alternative tools, but context is clear.

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/fastmcp-me/mcp-outline'

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