Skip to main content
Glama

explain_rule

Retrieve the severity, meaning, and remediation guidance for an individual security audit rule before acting on scan findings.

Instructions

查询单条规则的严重度、含义与修复建议

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": {
      "rule": "<rule>"
    },
    "name": "explain_rule"
  }
}

Input Schema

NameRequiredDescriptionDefault
ruleYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.1

TDQS

B3/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden, and it discloses little beyond output facets. It never states whether the operation is read-only (only implied by 查询), what happens for an unknown rule, whether a full ID or a name is accepted, or any auth/rate considerations. For a no-annotation tool this leaves meaningful gaps.

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 compact clause with the resource and the three return facets front-loaded, and no redundant wording. It is efficient, though the extreme brevity borders on under-specification rather than polished structure.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter lookup with no output schema and no annotations, the description tells the agent what information comes back, which is the most important thing. It is still thin on identifier format and error behavior, so it is adequate but not complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has one required parameter, 'rule', at 0% description coverage, and the description only echoes that it refers to a single rule. It adds no format guidance (rule ID vs. name vs. pattern) or examples, so it fails to compensate for the schema gap.

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 gives a specific verb (查询/explain) and resource (单条规则, a single rule), and even enumerates the returned facets: severity, meaning, and remediation advice. The word 单条 implicitly separates it from list_rules, but no sibling is named explicitly, so it stops short of a 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?

Usage is only implied: an agent can infer this is the look-up tool for a single rule once the rule is known, presumably after list_rules or a scan surfaces one. There is no explicit when-to-use, when-not-to-use, or named alternative, so it is minimum viable rather than instructive.

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