Skip to main content
Glama

outline_create_document

Create new documents in Outline with Markdown content, titles, and optional organization into collections or nested structures.

Instructions

Create a new document in Outline

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesThe title of the document
textYesThe content of the document in Markdown format
collectionIdNoOptional collection ID to create the document in
parentDocumentIdNoOptional parent document ID for nested documents
publishNoWhether to publish the document immediately (default: false)

Implementation Reference

  • The actual implementation of the 'createDocument' method in the OutlineClient class, which interacts with the Outline API.
    async createDocument(data: {
      title: string;
      text: string;
      collectionId?: string;
      parentDocumentId?: string;
      publish?: boolean;
    }): Promise<Document> {
      const payload: any = {
        title: data.title,
        text: data.text,
        publish: data.publish || false,
      };
    
      if (data.collectionId) {
        payload.collection = data.collectionId;
      }
      if (data.parentDocumentId) {
        payload.parentDocumentId = data.parentDocumentId;
      }
    
      const endpoints = ['/api/documents.create', '/api/documents/create', '/api/documents', '/api/document/create'];
    
      for (const endpoint of endpoints) {
        try {
          const response = await this.api.post(endpoint, payload);
          return response.data.data || response.data;
        } catch (error: any) {
          if (error.response?.status === 404 && endpoint !== endpoints[endpoints.length - 1]) {
            console.error(`Endpoint ${endpoint} not found, trying next...`);
            continue;
          }
          throw error;
        }
      }
      throw new Error('No valid endpoint found for creating document');
    }
  • The MCP handler block that calls 'outlineClient.createDocument' when the 'outline_create_document' tool is invoked.
    case 'outline_create_document':
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(
              await this.outlineClient.createDocument({
                title: args.title as string,
                text: args.text as string,
                collectionId: args.collectionId as string,
                parentDocumentId: args.parentDocumentId as string,
                publish: args.publish as boolean,
              }),
              null,
              2
            ),
          },
        ],
      };
  • The MCP schema definition for the 'outline_create_document' tool.
      name: 'outline_create_document',
      description: 'Create a new document in Outline',
      inputSchema: {
        type: 'object',
        properties: {
          title: {
            type: 'string',
            description: 'The title of the document',
          },
          text: {
            type: 'string',
            description: 'The content of the document in Markdown format',
          },
          collectionId: {
            type: 'string',
            description: 'Optional collection ID to create the document in',
          },
          parentDocumentId: {
            type: 'string',
            description: 'Optional parent document ID for nested documents',
          },
          publish: {
            type: 'boolean',
            description: 'Whether to publish the document immediately (default: false)',
            default: false,
          },
        },
        required: ['title', 'text'],
      },
    },
Behavior2/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. It fails to mention what the tool returns (document ID, full object, or nothing), error handling for invalid parentDocumentIds, side effects of publishing, or required authentication/authorization levels.

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 a single, front-loaded sentence with no filler words. It is appropriately concise, though it errs on the side of minimalism given the tool's complexity. The structure is correct with the action verb leading.

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 the tool has 5 parameters including optional nesting (parentDocumentId) and publishing logic (publish), plus no output schema or annotations, the 6-word description is insufficient. It omits return value semantics, hierarchical document relationships, and default behaviors.

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

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the structured schema already documents all parameters (title, text, collectionId, parentDocumentId, publish) adequately. The description adds no parameter-specific guidance, but the baseline score of 3 applies given the comprehensive schema.

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 uses a specific verb ('Create') and resource ('document') and identifies the target system ('in Outline'), making the basic purpose clear. However, it does not distinguish from sibling tools like outline_update_document or outline_get_document.

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 (e.g., when to create vs. update), nor does it mention prerequisites such as needing a valid collectionId or permissions to publish.

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

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