Skip to main content
Glama

create_document

Create a new document in a specified collection. Supports setting title, text content, parent document, publish status, template, and icon.

Instructions

    Creates a new document in a specified collection.

    Use this tool when you need to:
    - Add new content to a knowledge base
    - Create documentation, guides, or notes
    - Add a child document to an existing parent
    - Start a new document thread or topic
    - Create a reusable template document

    Note: For Mermaid diagrams, use ```mermaidjs
    (not ```mermaid) as the code fence language
    identifier for proper rendering.

    Args:
        title: The document title
        collection_id: The collection ID to create in
        text: Optional markdown content for the document
        parent_document_id: Optional parent document ID
            for nesting
        publish: Whether to publish immediately (True)
            or save as draft (False)
        template: If True, creates the document as a
            template
        icon: Optional emoji character to use as the
            document icon (e.g. "📋", "🚀"). If None,
            no icon is set.

    Returns:
        Result message with the new document ID
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNo
textNo
titleYes
publishNo
templateNo
collection_idYes
parent_document_idNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Annotations already indicate readOnlyHint=false (mutation) and idempotentHint=false. The description adds the Mermaid code fence detail and mentions the return format, but lacks information on authorization, error handling, or side effects. Adequate but not rich.

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?

The description is well-structured with paragraphs and bullet lists, but it is a bit verbose, including a tangential Mermaid note. However, every sentence adds value, and the argument descriptions are front-loaded.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers parameter semantics well but is vague about the output, only stating a 'Result message with the new document ID.' With no output schema provided, this leaves ambiguity about the exact structure. Adequate for a creation tool but not fully complete.

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

Parameters5/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 does so thoroughly with an 'Args:' section that explains each parameter's purpose, including optionality, default behavior (e.g., publish default True), and allowed values (e.g., emoji for icon).

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 starts with a clear verb+resource: 'Creates a new document in a specified collection.' It distinguishes from siblings like update_document, delete_document, etc., and provides a list of use cases that reinforce its purpose.

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

Usage Guidelines4/5

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

The description explicitly lists five use cases for when to use the tool, helping agents decide. It does not explicitly state when not to use it or mention alternatives, but the context of sibling tools makes it clear.

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

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