getCodeActions

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

The description aligns with the readOnlyHint annotation (true) by describing a read operation. However, it adds no additional behavioral context beyond what annotations provide (e.g., no mention of side effects or analysis triggers). No contradiction.

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?

One concise sentence (13 words) that clearly states the purpose with no unnecessary words or repetition. Excellent front-loading.

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 tool has 5 required params, no output schema, and a simple read operation. The description is sufficient for the agent to understand the basic purpose, though it does not specify the return format (e.g., list of action names). Given the simplicity, this is a minor gap.

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 coverage is 100% for all 5 parameters. The description only mentions 'range in a file', which does not add meaning beyond the schema descriptions (e.g., line/column numbers). Baseline 3 is appropriate.

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?

The description explicitly states the verb 'Get', the resource 'code actions', and the scope 'for a range in a file'. It clearly distinguishes from siblings like applyCodeAction (which applies the action) and previewCodeAction (which previews).

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?

The description does not provide guidance on when to use this tool versus alternatives (e.g., applyCodeAction, previewCodeAction). The context is implied but no explicit when-to or when-not-to guidance.

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