Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

list_archived_documents

Retrieve archived documents from Outline wiki to restore or reference previous content, with configurable result limits.

Instructions

Get list of archived documents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo

Implementation Reference

  • The handler function that executes the list_archived_documents tool. It calls the Outline API to fetch archived documents with the given limit and formats the response using formatArchivedDocuments.
    async list_archived_documents(args: ListArchivedDocumentsInput) {
      const { data } = await apiCall(() =>
        apiClient.post<OutlineDocument[]>('/documents.archived', { limit: args.limit })
      );
      return formatArchivedDocuments(data || []);
    },
  • Zod input schema for list_archived_documents tool, defining an optional 'limit' parameter defaulting to 25.
    export const listArchivedDocumentsSchema = z.object({ limit: limit.default(25) });
  • Registration of the list_archived_documents tool in the allTools array, specifying name, description, and linking to its Zod schema.
    createTool(
      'list_archived_documents',
      'Get list of archived documents.',
      'list_archived_documents'
    ),
  • TypeScript type definition for the input parameters of list_archived_documents, inferred from the Zod schema.
    export type ListArchivedDocumentsInput = z.infer<typeof listArchivedDocumentsSchema>;
  • The schema is mapped to the tool name in the toolSchemas object used for tool definitions.
    list_archived_documents: listArchivedDocumentsSchema,
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'Get list of archived documents,' implying a read-only operation, but does not specify any behavioral traits such as pagination, sorting, authentication requirements, rate limits, or what happens if no archived documents exist. This leaves significant gaps in understanding how the tool behaves beyond its basic purpose.

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 extremely concise with a single sentence, 'Get list of archived documents,' which is front-loaded and wastes no words. Every part of the sentence directly contributes to the tool's purpose, making it efficient and easy to parse, though it may be overly brief for completeness.

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 the tool's moderate complexity (a list operation with one parameter), no annotations, no output schema, and low schema description coverage (0%), the description is incomplete. It lacks details on behavioral aspects, usage context, and what the output entails (e.g., format, structure). For a tool that interacts with archived documents, more context is needed to ensure proper use, making it inadequate overall.

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 input schema has one parameter ('limit') with 0% description coverage, meaning the schema provides no semantic context. The description does not mention any parameters, so it adds no explicit parameter semantics. However, since there is only one parameter and the tool's purpose is straightforward (listing archived documents), the lack of parameter details is less critical, warranting a baseline score of 4 for minimal parameter complexity.

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

Purpose3/5

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

The description 'Get list of archived documents' clearly states the verb ('Get') and resource ('archived documents'), making the basic purpose understandable. However, it lacks specificity about what 'Get' entails (e.g., retrieval, listing, filtering) and does not distinguish this tool from potential siblings like 'list_recent_documents' or 'list_trash', which are similar list operations. This results in a vague but not misleading purpose.

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. It does not mention any context, prerequisites, or exclusions, such as how it differs from 'list_recent_documents' or 'list_trash' in terms of scope or filtering. Without such information, users must infer usage from the tool name alone, which is insufficient for clear decision-making.

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-smart-mcp'

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