Skip to main content
Glama

ClearPolicy

by app.clearpolicy.api
OverviewDiscussionsAdmin

Get Document Tool

get-document-tool
Read-onlyIdempotent

Get details of a document, including how many people have signed it and how many haven't.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idYesThe ULID of the document.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameYes
app_urlYes
archivedYes
edit_urlNo
auto_renewNo
resource_uriYes
attestation_countsNo
current_version_idNo
renewal_interval_daysNo
has_published_revisionYes
default_attestation_typeNo
current_version_published_atNo
latest_published_revision_pdf_uriNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / default_attestation_type / enum
      Previous value: -[
-  "acknowledgment",
-  "signature"
-]New value: +[
+  "signature",
+  "acknowledgment"
+]
  2. Changed4 schema fields changed
    • addedOutput schema / properties / app_url
      Added value: +{
+  "type": "string"
+}
    • addedOutput schema / properties / edit_url
      Added value: +{
+  "type": [
+    "string",
+    "null"
+  ]
+}
    • addedOutput schema / properties / resource_uri
      Added value: +{
+  "type": "string"
+}
    • changedOutput schema / required
      Previous value: -[
-  "id",
-  "name",
-  "has_published_revision",
-  "archived"
-]New value: +[
+  "id",
+  "name",
+  "has_published_revision",
+  "archived",
+  "resource_uri",
+  "app_url"
+]
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "archived": {
+      "type": "boolean"
+    },
+    "attestation_counts": {
+      "properties": {
+        "attested_latest": {
+          "type": "integer"
+        },
+        "attested_outdated": {
+          "type": "integer"
+        },
+        "pending_attested": {
+          "type": "integer"
+        },
+        "renewal_due": {
+          "type": "integer"
+        },
+        "total": {
+          "type": "integer"
+        },
+        "unrequested": {
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    },
+    "auto_renew": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "current_version_id": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "current_version_published_at": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "default_attestation_type": {
+      "enum": [
+        "acknowledgment",
+        "signature"
+      ],
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "has_published_revision": {
+      "type": "boolean"
+    },
+    "id": {
+      "type": "string"
+    },
+    "latest_published_revision_pdf_uri": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "renewal_interval_days": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "has_published_revision",
+    "archived"
+  ],
+  "type": "object"
+}
  4. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already disclose readOnly, idempotent, and non-destructive behavior, so the description only needs to add extra context. It does add the useful detail that the response includes signed/unsigned counts, but doesn't go beyond that. No contradiction with annotations.

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?

A single, front-loaded sentence that states the action and key output detail without filler. Every word earns its place.

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?

Simple one-parameter read tool; annotations already disclose safety, and the output schema covers return value details. No missing context needed to invoke it correctly.

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?

The single parameter is fully documented in the schema as a ULID; description adds no additional semantic detail. With 100% schema coverage, the baseline of 3 is appropriate.

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?

The description states a specific verb and resource ('Get details of a document') and adds concrete differentiating information about signed/unsigned counts. It is clear that this is the document-level read tool, though it doesn't explicitly distinguish itself from get-document-revision-tool or the search/query siblings.

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?

There is no guidance on when to use this tool versus alternatives like list-documents-tool, query-docs, or search-docs. The intended context is inferable from the name and one-liner, but the description never explicitly states selection criteria or 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