Skip to main content
Glama

Explain Guard Policy

codapult_guard_explain

Look up an active Guard rule or contract by ID to get its definition, evidence, guidance, and suggested next steps when a check reports a rule ID or you need to decide how to comply.

Instructions

Look up one active Guard rule or contract by ID and return its definition, evidence, guidance, and suggested next steps. Use when a check reports a rule ID or when deciding how to comply. For a finding-specific explanation, inspect the finding from codapult_guard_check or codapult_guard_audit as well.

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": {
      "id": "<id>"
    },
    "name": "codapult_guard_explain"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesExact rule or contract ID from Guard policy or a finding.
rootNoProject path or workspace root.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.13.2
    • addedInput schema / properties / id / description
      Added value: +"Exact rule or contract ID from Guard policy or a finding."
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It usefully discloses the response payload shape (definition, evidence, guidance, suggested next steps) and implies only 'active' rules resolve, but says nothing about behavior for unknown/retired IDs, permissions, or error modes.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the lookup action and its return contents. Each sentence carries a distinct signal; no filler or restatement of the title.

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 simple two-parameter read tool with no output schema and no annotations, enumerating the return contents is the key compensating detail. Minor gap: no statement of what happens when a rule ID is not found or is inactive.

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 both parameters are already documented in the schema. The description adds a little context on the ID's provenance ('from Guard policy or a finding') but contributes nothing on `root`. Baseline 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?

States a specific verb and resource ('look up one active Guard rule or contract by ID') and enumerates what comes back (definition, evidence, guidance, next steps). It's clearly not a check/audit tool, though the differentiation from siblings like codapult_guard_context or codapult_guard_governance is left to the usage sentence rather than the purpose itself.

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?

Gives concrete trigger conditions: 'Use when a check reports a rule ID or when deciding how to comply.' It also routes the agent elsewhere for finding-specific explanations by naming codapult_guard_check and codapult_guard_audit. No explicit when-not conditions or mention of most other sibling tools.

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