Skip to main content
Glama
huiseo
by huiseo

export_document

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

Instructions

Export document in Markdown format.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes

Implementation Reference

  • The core handler function for the 'export_document' tool. It receives ExportDocumentInput containing the documentId, makes an API call to Outline's '/documents.export' endpoint, and returns the exported document content (Markdown format).
    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 tool: requires a 'documentId' string.
    export const exportDocumentSchema = z.object({ documentId });
  • TypeScript type inferred from the exportDocumentSchema for type safety in handlers.
    export type ExportDocumentInput = z.infer<typeof exportDocumentSchema>;
  • src/lib/tools.ts:68-73 (registration)
    Registers the 'export_document' tool definition, including name, description, and references the Zod schema converted to JSON Schema for MCP protocol.
    createTool(
      'export_document',
      'Export document in Markdown format.',
      'export_document'
    ),
  • Maps the tool name 'export_document' to its schema in the central toolSchemas object used across the application.
    export_document: exportDocumentSchema,
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 offers minimal behavioral insight. It implies a read-only operation (exporting) but doesn't disclose permissions needed, rate limits, whether it's destructive to the document, output handling (e.g., file download vs. text return), or error conditions. This leaves significant gaps for a tool with potential 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?

The description is extremely concise—a single sentence with zero wasted words. It's front-loaded with the core action and format, making it easy to parse quickly. Every word earns its place by specifying the export 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?

Given no annotations, 0% schema coverage, no output schema, and a single parameter, the description is incomplete. It lacks details on behavior, output format beyond 'Markdown', error handling, and integration context. For a tool that likely produces content, more guidance is needed to ensure correct usage.

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%, and the description adds no parameter information beyond what's inferred from the tool name. It doesn't explain what 'documentId' represents (e.g., format, source), validation rules, or examples. For a single required parameter with no schema documentation, this is inadequate compensation.

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 action ('Export') and resource ('document') with specific output format ('Markdown format'), which distinguishes it from siblings like 'get_document' or 'summarize_document'. However, it doesn't explicitly differentiate from 'export_collection' or 'export_all_collections' which handle different scopes.

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 doesn't mention prerequisites (e.g., document must exist), contrast with 'get_document' (which retrieves metadata/content without export), or specify scenarios where export is preferred over other operations.

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