Get rule details

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

With no annotations, the description must fully disclose behavior. Only states 'read-only' which is already implied by the verb. Missing details on error handling, rate limits, authentication, or what happens with invalid ruleKey.

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

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

A single sentence is concise but too minimal. It lacks necessary details to be truly helpful. Structure is front-loaded but insufficient for the information content.

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

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

The description does not explain the return value or differentiate from sibling tools effectively. Given the simplicity (1 param, no output schema), it could be complete with minimal addition but falls short.

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

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

Schema description coverage is 0%, yet the description provides no information about the 'ruleKey' parameter. The parameter's purpose (e.g., format or examples) is absent, leaving the agent to infer from the schema alone.

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

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

Clearly states verb 'Get', resource 'rule details', and specifies 'read-only' to indicate safe operation. The tool's purpose is distinct from sibling tools like search_sonar_issues or get_component_measures.

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

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

Implies usage for read-only rule details but provides no explicit guidance on when to use this tool versus alternatives like search_sonar_issues or get_component_measures. No when-not-to-use or prerequisite information.

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