Skip to main content
Glama
Sign In

ClearPolicy

by app.clearpolicy.api
OverviewDiscussionsAdmin

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

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

NameRequiredDescriptionDefault
documentYes
revisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / revision / properties / lock_version
      Added value: +{
+  "type": "integer"
+}
    • changedOutput schema / properties / revision / required
      Previous value: -[
-  "id",
-  "document_id",
-  "status",
-  "source_type",
-  "content_markdown",
-  "content_text",
-  "is_empty",
-  "resource_uri",
-  "app_url"
-]New value: +[
+  "id",
+  "lock_version",
+  "document_id",
+  "status",
+  "source_type",
+  "content_markdown",
+  "content_text",
+  "is_empty",
+  "resource_uri",
+  "app_url"
+]
  2. 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"
+]
  3. 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"
-}
  4. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations declare non-readonly, non-destructive, non-idempotent, but do not convey the crucial trait that the output is an unpublished draft. The description supplies that state and the intended review-then-publish lifecycle, adding real behavioral value beyond the annotations, though it omits permission/auth or uniqueness requirements.

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?

Three short sentences that front-load the primary action and then the state constraint and follow-up. No redundant restatement of the name or schema fields, 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 annotations covering the safety profile and an output schema present, the description need not explain return values; it covers purpose, draft state, and next step. It is nearly complete, lacking only mention of required inputs or permission prerequisites for creation.

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 the schema already documents name, summary, and body_markdown including the 255-character limit and supported Markdown constructs. The description only echoes the optional Markdown body, adding no format or constraint detail beyond the schema — baseline 3 applies.

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?

States a specific verb and resource ('Create a new ClearPolicy document with a draft rich-text revision') and clarifies scope by contrasting with publishing. It names publish-document-revision-tool as the alternative, but it does not distinguish this tool from the sibling create-document-revision-tool, leaving some ambiguity about which creates the container vs. the 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?

Explicitly states the negative case ('Does not publish') and gives the follow-up tool with the condition ('after the user reviews the draft'), which is genuine workflow guidance. It does not say when to prefer this over create-document-revision-tool, so it is clear context without full exclusions.

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

All ClearPolicy toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources