Get source lines

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

The description mentions 'read-only,' indicating non-destructive behavior. However, with no annotations, it lacks detail on permissions, output format, or edge cases (e.g., empty results).

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?

Single sentence, no redundant text, front-loaded with the essential action. Efficient and clear.

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?

With 5 parameters, no output schema, and no annotations, the description is too brief. It omits details on return value, optional vs required parameters, and usage constraints.

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 has zero description coverage (0%), so description must compensate. It fails to explain the meaning of 'component,' 'from,' 'to,' 'branch,' or 'pullRequest,' offering little beyond the schema itself.

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?

Description clearly states 'Get read-only SonarQube source lines for a component,' specifying verb, resource, and context. It distinguishes from sibling tools by focusing on source lines.

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?

Description implies usage when source lines are needed but provides no explicit guidance on when to use this tool versus alternatives (e.g., searching for source, fetching measures). No exclusions or context are mentioned.

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