Skip to main content
Glama

export_collection

Export all documents from a collection into downloadable files. Preserves hierarchy and content in formats like Outline Markdown, JSON, or HTML. Use for backups, sharing, converting, or archiving content. Asynchronous operation provides status and access details upon completion.

Instructions

    Exports all documents in a collection to a downloadable file.
    
    IMPORTANT: This tool starts an asynchronous export operation which may 
    take time to complete. The function returns information about the 
    operation, including its status. When the operation is complete, the 
    file can be downloaded or accessed via Outline's UI. The export 
    preserves the document hierarchy and includes all document content and 
    structure in the 
    specified format.
    
    Use this tool when you need to:
    - Create a backup of collection content
    - Share collection content outside of Outline
    - Convert collection content to other formats
    - Archive collection content for offline use
    
    Args:
        collection_id: The collection ID to export
        format: Export format ("outline-markdown", "json", or "html")
        
    Returns:
        Information about the export operation and how to access the file
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collection_idYes
formatNooutline-markdown
Behavior4/5

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

With no annotations provided, the description carries full burden and does well by disclosing key behavioral traits: asynchronous operation, potential time delay, returns operation status information, and that completion enables download/UI access. It doesn't mention rate limits, authentication needs, or error conditions, but covers the essential asynchronous nature thoroughly.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with clear sections: purpose statement, important behavioral notes, usage guidelines, and parameter/return explanations. Some redundancy exists (e.g., 'preserves document hierarchy' could be implied from export), but overall efficiently communicates necessary information without fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/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 2 parameters with 0% schema coverage, the description does well by covering purpose, behavior, usage, parameters, and returns. It could mention error cases or authentication requirements, but provides sufficient context for an agent to understand and invoke the tool appropriately.

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?

Schema description coverage is 0%, so the description must compensate. It adds meaningful context for both parameters: 'collection_id: The collection ID to export' and 'format: Export format ("outline-markdown", "json", or "html")' including the enum values not in schema. It doesn't specify format details or collection_id constraints, but provides essential semantic clarification.

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

Purpose5/5

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

The description clearly states the specific action ('Exports all documents in a collection to a downloadable file') and distinguishes it from sibling tools like 'export_document' (single document) and 'export_all_collections' (all collections). It specifies the resource (collection documents) and outcome (downloadable file).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage scenarios with a bulleted list ('when you need to: - Create a backup... - Share... - Convert... - Archive...'). It implicitly distinguishes from alternatives like 'export_document' (single document) and 'export_all_collections' (all collections) by specifying 'collection' scope.

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

Related 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/Vortiago/mcp-outline'

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