Skip to main content
Glama

Explain a rule

droidmap_explain
Read-onlyIdempotent

Explains one rule: what it finds, the crash or data loss it prevents, and how to fix it with code examples. Use it when a check or diff finding is unclear and you need a fix.

Instructions

Explain one droidmap rule: what it finds, why it matters (the crash or data loss it prevents) and how to fix what it found, with code examples, and its page online. Use it when droidmap_check or droidmap_diff reports a finding you do not know how to fix. It reads documentation bundled with droidmap, so it needs no project and changes nothing. Returns Markdown.

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": "droidmap_explain"
  }
}

Input Schema

NameRequiredDescriptionDefault
ruleYesThe rule's id, as each finding shows it, such as 'room-migration-path' or 'hilt-missing-binding'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • addedInput schema / properties / rule / description
      Added value: +"The rule's id, as each finding shows it, such as 'room-migration-path' or 'hilt-missing-binding'."
  2. First observedv0.1.0

TDQS

A4.2/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 largely covered. The description still adds genuinely useful context the annotations cannot: it reads documentation bundled with droidmap, needs no project, changes nothing, and returns Markdown. It stops short of describing length, error behavior for an unknown rule id, or whether the online page link is always present.

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?

Purpose is front-loaded and every clause carries information (output contents, when to use, side-effect profile, return format). The opening sentence is long and packs three clauses together, which slightly hurts scannability but wastes nothing.

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?

For a one-parameter, side-effect-free lookup tool with no output schema, the description covers purpose, trigger, prerequisites (none), safety, and return type. Nothing an agent needs in order to invoke it correctly is missing.

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 parameter is a fully enumerated list of 35 rule ids with an example-bearing description. The description only restates that the argument is a rule, so the schema does all the semantic work and baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource ('Explain one droidmap rule') and then enumerates exactly what the output covers: what it finds, why it matters, how to fix it, code examples, and its online page. That scope is concrete enough to separate it from droidmap_show or droidmap_report without opening any schema.

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

Usage Guidelines5/5

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

It states the triggering condition explicitly: use it when droidmap_check or droidmap_diff reports a finding you do not know how to fix. Both the situation and the sibling tools that produce it are named, so an agent can route here without inference.

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