Skip to main content
Glama
vigilai-tech

record-mcp

by vigilai-tech

get_rule

Read-onlyIdempotent

Retrieves the full definition of a compliance rule by ID, including description, citations, parameters, and remediation guidance for audit validation.

Instructions

Full definition of one rule: description, citations, params, remediation.

Input Schema

NameRequiredDescriptionDefault
rule_idYese.g. REC-HO-001

Output Schema

NameRequiredDescriptionDefault
idYes
checkYesName of the registered Python check that implements the rule.
scopeYes
sinceNo0.1.0
titleYes
fieldsNo
paramsNo
sourceNo'catalog' (YAML) or the generator name.catalog
categoryYes
severityYes
citationsYes
applies_toNo
descriptionYes
remediationYes
framework_agnosticNoEvaluate even when the caller filters by framework.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is fully covered elsewhere. The description adds that the result is a full definition rather than a summary, but says nothing about behavior for an unknown rule_id or any error/lookup semantics.

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?

A single front-loaded sentence listing the returned sections with zero filler. It is terse to the point of being fragmentary, but nothing is wasted.

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 a rich output schema, full annotations, and one required parameter, the description only needs to signal what the tool fetches, which it does. The remaining gap is routing against list_rules rather than return-value detail.

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 coverage is 100% and the single rule_id parameter already carries an example format (REC-HO-001). The description contributes no additional meaning about the identifier beyond what the schema states, so 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 (get) and resource (one rule) plus the payload contents (description, citations, params, remediation), so the agent knows exactly what a call returns. It does not explicitly name the sibling list_rules, but 'one rule' versus a list is implicit.

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?

Usage is only implied: 'one rule' suggests you already have a rule_id, which in turn implies list_rules is how you discover one. No explicit when-to-use, when-not, or named alternative is given.

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