Skip to main content
Glama
huiseo
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 primary handler function that implements the logic for exporting a collection by calling the Outline API endpoint '/collections.export' with the provided collection ID and format.
    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 defining the input for export_collection: collectionId (UUID string) and format (enum ['outline-markdown', 'json'], default 'outline-markdown'). Relies on shared fragments collectionId and exportFormat defined earlier.
    export const exportCollectionSchema = z.object({ collectionId, format: exportFormat });
  • Registers the export_collection tool by creating its MCP tool definition (name, description, input JSON Schema derived from Zod schema via createTool).
    createTool(
      'export_collection',
      'Export a collection.',
      'export_collection'
    ),
Behavior1/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 operation that generates output, but it doesn't specify permissions needed, rate limits, side effects (e.g., file creation), or what the export produces (e.g., a downloadable file). This is inadequate for a tool with potential behavioral complexity.

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 under-specified, it's structurally efficient with no redundant information.

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 address what the export does (e.g., returns a file, triggers a process), behavioral traits, or parameter meanings, making it insufficient for an agent to use the tool effectively without additional context.

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%, so the description must compensate for undocumented parameters. It mentions 'collection' but doesn't explain 'collectionId' or 'format' parameters. The description adds minimal value beyond the schema, failing to clarify what a 'collection' is or how the export works, leaving key semantics 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' clearly states the action (export) and target (collection), but it's vague about what 'export' entails (e.g., file generation, data transfer) and doesn't differentiate from sibling tools like 'export_all_collections' or 'export_document'. It avoids tautology by not restating the name, but lacks specificity.

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?

No guidance is provided on when to use this tool versus alternatives like 'export_all_collections' or 'export_document'. The description doesn't mention prerequisites, exclusions, or context for choosing this tool over others, leaving the agent to infer usage based on tool names alone.

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