Skip to main content
Glama

Policy: acknowledge

policy_acknowledge

Record that a person read and accepted the current version of a policy. The fingerprint must match the current version, so nobody signs off on an old document. Requires the organization API key.

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": {
      "policy_id": "<policy_id>",
      "person": "<person>",
      "document_sha256": "<document_sha256>"
    },
    "name": "policy_acknowledge"
  }
}

Input Schema

NameRequiredDescriptionDefault
personYesName or email of the person acknowledging
policy_idYes
document_sha256YesSHA-256 fingerprint of the document (64 hex characters); the file stays with you

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare this is a non-read-only, non-idempotent, non-destructive, open-world write. The description adds two things annotations cannot: the fingerprint must equal the current version (so stale documents are rejected) and an organization API key is required. It does not explain what happens on a fingerprint mismatch or whether repeat acknowledgments are permitted, which is the remaining gap.

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, no filler: the action comes first, followed by the validation rationale and the auth requirement. Every clause carries information an agent needs before calling.

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?

For a three-required-parameter write tool with no output schema, the description covers purpose, a key validation rule, and auth. What is missing is failure behavior on fingerprint mismatch and whether re-acknowledging an already-acknowledged policy is allowed (relevant given idempotentHint=false), but the definition is otherwise sufficient to invoke correctly.

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?

Schema coverage is 67%, with person and document_sha256 already documented in-schema. The description still adds meaning by explaining what the fingerprint is compared against (the current policy version), which is not stated anywhere in the schema, and it implies policy_id selects the policy being signed off. That is genuine value beyond the structured fields.

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: 'Record that a person read and accepted the current version of a policy.' That is clearly distinct from publishing (policy_publish) or checking state (policy_status), so an agent can route correctly. It stops short of explicitly naming a sibling or contrasting behavior, which keeps it at 4 rather than 5.

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

Usage Guidelines3/5

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

The description gives a real precondition ('The fingerprint must match the current version') and an auth requirement ('Requires the organization API key'), which is useful operational guidance. However, it never says when to choose this tool over related ones or when not to call it (e.g., already-acknowledged cases), so usage is only implied.

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