Skip to main content
Glama

create_doc

Create a document in a project and return its metadata and version so you can edit it immediately without a separate read.

Instructions

Create a document in a project. Returns its metadata and version — the version is what update_doc takes as base_version, so a create followed by an edit needs no read in between. The body you sent is not echoed back. slug is ONE path segment and must not contain '/' (the request is refused with 400): a document in a folder is created with parent_id set to the parent's id, and is then reachable as /.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project_id": "<project_id>",
      "title": "<title>"
    },
    "name": "create_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyNoMarkdown body.
slugNoOne URL segment, derived from the title if omitted. '/' is not allowed (400) — nest with parent_id instead.
titleYesDocument title.
positionNoSort position among siblings.
parent_idNoParent document UUID, to nest this one under it.
project_idYesProject UUID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (which only give the safety profile), it discloses concrete behavior: the body is not echoed back, the return includes metadata and version, and the version chains directly into update_doc. It also explains the 400 refusal on '/' in slug and how nesting works via parent_id — rich context annotations cannot express.

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?

Front-loaded with the core action, then the two non-obvious operational facts (version chaining, body not echoed) and the slug constraint. Every sentence carries distinct, useful information with no padding.

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

Completeness5/5

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

No output schema exists, yet the description fully explains the return value (metadata plus version) and its downstream use, and covers the one tricky parameter constraint. Nothing an agent needs to call it correctly is missing.

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?

With 100% schema coverage, the baseline is 3; the description adds real meaning by explaining the slug one-segment/no-slash constraint and the 400 consequence, plus how parent_id produces a <parent-slug>/<slug> path. This compensates and enriches the schema rather than repeating it.

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?

States a specific verb and resource ('Create a document in a project') and clearly distinguishes itself from siblings by referencing update_doc's base_version workflow. An agent can tell exactly what this does versus get_doc or update_doc.

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?

Explains the key workflow context — that a create followed by an edit needs no read in between because the version is returned. It gives clear usage context but stops short of explicitly naming when to prefer another sibling (e.g., get_doc for existing docs).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.