Skip to main content
Glama

Create Document Tool

create-document-tool

Create a new ClearPolicy document with a draft rich-text revision. Optionally set the initial body as Markdown. Does not publish — use publish-document-revision after the user reviews the draft.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDocument title as it will appear in ClearPolicy.
summaryNoOptional short summary of this draft revision (max 255 characters).
body_markdownNoOptional Markdown body for the first draft. Headings, paragraphs, lists, and links are supported.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentYes
revisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / document / properties / requires_signature
      Added value: +{
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / document / required
      Previous value: -[
      -  "id",
      -  "name",
      -  "has_published_revision",
      -  "resource_uri",
      -  "app_url"
      -]New value: +[
      +  "id",
      +  "name",
      +  "requires_signature",
      +  "has_published_revision",
      +  "resource_uri",
      +  "app_url"
      +]
  2. Changed1 schema field changed
    • removedInput schema / properties / requires_signature
      Removed value: -{
      -  "description": "If true (default), recipients type their name as a signature. If false, a simple acknowledgment is used.",
      -  "type": "boolean"
      -}
  3. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already convey this is a non-readonly, non-idempotent write operation. The description adds behavioral context beyond what annotations provide: new documents start as a 'draft' revision and the tool 'Does not publish.' This is operational detail that directly affects how an agent sequences the workflow. No contradiction with annotations exists.

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?

Two sentences with zero filler. The first states the core operation; the second delivers the critical constraint ('Does not publish') and routes to the right sibling. Information is front-loaded and every sentence earns its place.

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?

With an output schema present, return values need no explanation, and 100% parameter coverage handles invocation details. The description covers the critical workflow gap (draft vs. published state) and names the successor tool. The residual gap is the lack of explicit guidance distinguishing it from create-document-revision-tool, though that is reasonably inferable from 'new.'

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?

Schema description coverage is 100% — name, summary, and body_markdown are each documented in the schema. The description's phrase 'Optionally set the initial body as Markdown' is largely redundant with the schema's 'Optional Markdown body for the first draft.' Baseline 3 applies because the schema carries the parameter-documentation burden.

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 states a specific verb and resource: 'Create a new ClearPolicy document with a draft rich-text revision.' It also differentiates from siblings by clarifying that the tool creates the document along with its initial draft revision, which distinguishes it from create-document-revision-tool, and the 'Does not publish' clause separates it from publish-document-revision.

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 names the follow-up tool: 'use publish-document-revision after the user reviews the draft,' which tells the agent when this tool alone is insufficient. However, it never explicitly contrasts with create-document-revision-tool for adding revisions to existing documents; the distinction is implied by the word 'new' but not stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources