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. 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"
      -}
  2. Added

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare destructiveHint=false, though not readOnlyHint (which is false, indicating mutation). The description doesn't contradict annotations and adds the behavioral context that the document is created as a draft, not published. However, it doesn't detail outcomes like what happens on revision creation or any unexpected side effects, but given annotations cover basic safety, this is adequate.

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 efficient information: states the action, optional body format, and the exception to not publish. No fluff, key behavioral note front-loaded.

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?

Given the tool's moderate complexity (3 parameters, output schema present), the description covers the essential usage and behavioral constraints. The output schema is richer, so the description doesn't need to explain return values. It adequately informs the agent on how to invoke correctly, with minor gaps on revision details that are not critical.

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%, so all parameters are already documented in the schema. The description adds context that body_markdown is Markdown for the first draft, which slightly enhances the schema's generic wording, but doesn't go beyond that. Baseline 3 is appropriate as the schema does the heavy lifting.

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 clearly states the tool's specific purpose: creating a new ClearPolicy document with a draft rich-text revision, and optionally setting the initial body as Markdown. It distinguishes this action from publishing, which is a separate tool. This verb+resource+scope combination is precise and unambiguous.

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

Usage Guidelines5/5

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

The description explicitly notes that this tool does not publish, and instructs to use publish-document-revision after user review. This provides clear when-to-use and when-not-to-use guidance, routing to the correct sibling tool.

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