Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

export_document

Export Outline wiki documents as Markdown files for backup, sharing, or content migration.

Instructions

Export document in Markdown format.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes

Implementation Reference

  • The handler function that executes the export_document tool by calling the Outline API endpoint '/documents.export' with the provided document ID and returns the exported document content (likely Markdown).
    async export_document(args: ExportDocumentInput) {
      const { data } = await apiCall(() =>
        apiClient.post<string>('/documents.export', { id: args.documentId })
      );
      return data;
    },
  • Zod schema defining the input for export_document: requires a documentId string.
    export const exportDocumentSchema = z.object({ documentId });
  • src/lib/tools.ts:68-72 (registration)
    MCP tool registration for export_document, specifying name, description, and referencing the Zod schema via createTool function.
    createTool(
      'export_document',
      'Export document in Markdown format.',
      'export_document'
    ),
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose whether this requires specific permissions, what happens if the document doesn't exist, whether the export is immediate or queued, or any rate limits. 'Export' suggests a read operation but lacks confirmation of safety or side effects.

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?

Extremely concise single sentence with zero waste. Every word contributes to the core purpose. The structure is front-loaded with the essential action and format.

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?

For a tool with no annotations, 0% schema description coverage, and no output schema, the description is inadequate. It doesn't explain what the export produces (file content? download link?), error conditions, or behavioral details needed for reliable use. The context demands more completeness.

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 but provides no parameter information. It doesn't explain what 'documentId' represents, how to obtain it, or format requirements beyond the schema's 'minLength: 1'. The single parameter remains semantically unclear.

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 ('Export') and resource ('document') with specific format ('Markdown format'). It distinguishes from siblings like 'export_collection' or 'export_all_collections' by focusing on single documents, but doesn't explicitly differentiate from other document export operations if they existed.

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 on when to use this tool versus alternatives like 'export_collection' or 'export_all_collections'. The description implies it's for single documents but doesn't specify prerequisites, limitations, or when other export methods might be more appropriate.

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