Skip to main content
Glama
huiseo
by huiseo

list_archived_documents

Retrieve archived documents from Outline wiki to restore or reference past content. Specify limit to control results.

Instructions

Get list of archived documents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo

Implementation Reference

  • The core handler function that implements the list_archived_documents tool. It calls the Outline API endpoint '/documents.archived' with the limit parameter and formats the results using formatArchivedDocuments.
    async list_archived_documents(args: ListArchivedDocumentsInput) {
      const { data } = await apiCall(() =>
        apiClient.post<OutlineDocument[]>('/documents.archived', { limit: args.limit })
      );
      return formatArchivedDocuments(data || []);
    },
  • Zod schema defining the input for list_archived_documents: an optional limit (default 25).
    export const listArchivedDocumentsSchema = z.object({ limit: limit.default(25) });
  • Registration of the schema in the central toolSchemas map used for tool definitions.
    list_archived_documents: listArchivedDocumentsSchema,
  • Tool registration in allTools array, converting the Zod schema to JSON schema for MCP tool definition.
    createTool(
      'list_archived_documents',
      'Get list of archived documents.',
      'list_archived_documents'
    ),
  • TypeScript type inferred from the schema for use in handler signatures.
    export type ListArchivedDocumentsInput = z.infer<typeof listArchivedDocumentsSchema>;
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states it 'gets' a list, implying a read operation, but doesn't disclose behavioral traits like pagination, sorting, permissions needed, rate limits, or what 'archived' entails. This is inadequate for a tool with no annotation coverage.

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 a single, efficient sentence with no wasted words. It's appropriately sized and front-loaded, making it easy to parse quickly.

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

Completeness2/5

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

Given no annotations, no output schema, and low schema coverage, the description is incomplete. It doesn't cover return values, error cases, or how archived documents are defined, leaving significant gaps for an agent to use the tool effectively.

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 1 parameter with 0% description coverage, and the tool description doesn't mention any parameters. Since there's only 1 parameter, the baseline is 4, but the description adds no value beyond the schema, so it's scored lower. It fails to explain what 'limit' controls or its impact.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Get') and resource ('list of archived documents'), making the purpose understandable. However, it doesn't differentiate from siblings like 'list_recent_documents' or 'list_trash', which also list documents with different filters, so it misses full sibling distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives such as 'list_recent_documents' or 'search_documents'. It lacks context on prerequisites, exclusions, or specific scenarios for archived versus other document states.

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/huiseo/outline-wiki-mcp'

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