Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

export_collection

Export Outline wiki collections to Markdown or JSON formats for backup, migration, or external use.

Instructions

Export a collection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collectionIdYes
formatNooutline-markdown

Implementation Reference

  • The main handler function for the 'export_collection' tool. It calls the Outline API to start exporting the specified collection in the given format and returns a success response with file operation details.
    async export_collection(args: ExportCollectionInput) {
      const { data } = await apiCall(() =>
        apiClient.post<unknown>('/collections.export', { id: args.collectionId, format: args.format })
      );
      return {
        success: true,
        collectionId: args.collectionId,
        format: args.format,
        fileOperation: data,
        message: MESSAGES.COLLECTION_EXPORT_STARTED,
      };
    },
  • Zod schema definition for 'export_collection' tool input, requiring a UUID collectionId and optional export format (default 'outline-markdown').
    export const exportCollectionSchema = z.object({ collectionId, format: exportFormat });
  • TypeScript type derived from the exportCollectionSchema for use in handlers.
    export type ExportCollectionInput = z.infer<typeof exportCollectionSchema>;
  • Registration of the 'export_collection' tool in the allTools array, converting the Zod schema to JSON Schema for MCP.
    createTool(
      'export_collection',
      'Export a collection.',
      'export_collection'
    ),
  • Entry in the toolSchemas map that associates 'export_collection' with its Zod schema.
    export_collection: exportCollectionSchema,
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. 'Export a collection' implies a read-only or data extraction operation, but it fails to specify aspects like output format details, file handling, permissions required, or potential side effects (e.g., if it modifies the collection). This leaves significant gaps in understanding the tool's behavior.

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, 'Export a collection.', which is front-loaded and wastes no words. While it may be under-specified, it is structurally efficient and easy to parse, earning full marks for conciseness.

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 complexity (2 parameters, no annotations, no output schema), the description is incomplete. It does not explain what 'export' means in practice, the parameters involved, or the expected output, making it inadequate for an agent to use the tool effectively without additional context or trial-and-error.

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

Parameters2/5

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

Schema description coverage is 0%, meaning parameters are undocumented in the schema. The description does not mention any parameters, such as 'collectionId' or 'format', nor does it explain their semantics (e.g., that 'format' can be 'outline-markdown' or 'json'). This fails to compensate for the lack of schema documentation, leaving parameters unclear.

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 'Export a collection' states a clear verb ('Export') and resource ('a collection'), providing a basic understanding of the tool's function. However, it lacks specificity about what 'export' entails (e.g., file generation, data transfer) and does not distinguish it from sibling tools like 'export_all_collections' or 'export_document', making it vague in comparison.

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 prerequisites, such as needing an existing collection, or compare it to siblings like 'export_all_collections' for bulk operations or 'export_document' for individual documents, leaving the agent without context for selection.

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