Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

create_document

Create new documents in Outline wiki with specified titles, content, and collection organization for structured knowledge management.

Instructions

Create a new document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
textNo
collectionIdYes
parentDocumentIdNo
publishNo

Implementation Reference

  • The main handler function for the 'create_document' tool. It performs access check and calls the Outline API to create a new document with the provided title, text, collection, parent, and publish settings.
    async create_document(args: CreateDocumentInput) {
      checkAccess(config, 'create_document');
      const { data } = await apiCall(() =>
        apiClient.post<OutlineDocument>('/documents.create', {
          title: args.title,
          text: args.text,
          collectionId: args.collectionId,
          parentDocumentId: args.parentDocumentId,
          publish: args.publish,
        })
      );
      return docResult(data, MESSAGES.DOCUMENT_CREATED);
    },
  • Zod schema defining the input parameters for create_document: title (required), text (optional), collectionId (optional UUID), parentDocumentId (optional UUID), publish (boolean, default true).
    export const createDocumentSchema = z.object({
      title: z.string().min(1, 'Title is required'),
      text: z.string().default(''),
      collectionId,
      parentDocumentId: z.string().uuid().optional(),
      publish: z.boolean().default(true),
    });
  • src/lib/tools.ts:75-79 (registration)
    Tool registration in the allTools array using createTool, specifying name 'create_document', description, and schema key.
    createTool(
      'create_document',
      'Create a new document.',
      'create_document'
    ),
  • Mapping of 'create_document' tool name to its schema in the toolSchemas object used by createTool.
    create_document: createDocumentSchema,
  • The createDocumentHandlers factory function that returns an object containing the create_document handler, among others. This is imported and spread in handlers/index.ts.
    export function createDocumentHandlers({ apiClient, apiCall, config }: AppContext) {
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'Create' implies a write operation, but doesn't disclose behavioral traits such as permissions needed, whether it's idempotent, rate limits, or what happens on failure. This leaves significant gaps for a mutation tool.

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 with a single sentence, 'Create a new document.', which is front-loaded and wastes no words. However, this conciseness comes at the cost of completeness, but structurally it's efficient.

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's complexity (5 parameters, mutation operation, no annotations, no output schema), the description is incomplete. It doesn't explain the creation process, return values, error handling, or how it fits with siblings, making it insufficient for effective use.

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. It adds no meaning beyond the schema—no explanation of what parameters like 'collectionId', 'parentDocumentId', or 'publish' do, their formats, or default behaviors. With 5 parameters, this is inadequate.

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

Purpose3/5

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

The description 'Create a new document' clearly states the verb ('Create') and resource ('document'), which is better than a tautology. However, it lacks specificity about what kind of document or system (e.g., wiki, CMS) and doesn't differentiate from sibling tools like 'batch_create_documents' or 'create_collection', making it vague in context.

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 is provided on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a collectionId), exclusions, or comparisons to siblings like 'batch_create_documents' for multiple documents or 'create_collection' for creating collections instead.

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