run_ros2_doctor

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

The description discloses that it checks environment setup and issues, implying a non-destructive diagnostic. No annotations are provided, but the description is transparent about its purpose and does not contradict any known behavior.

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?

Two short sentences that are front-loaded with the purpose, followed by an example. Every sentence adds value with no wasted words.

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?

Given zero parameters, no output schema, and a simple diagnostic action, the description is fully complete. It tells the user what it does and that it needs no arguments.

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?

The input schema is empty and description coverage is 100%, so no parameter description is needed. The description confirms no arguments are required, adding clarity.

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 clearly states it runs 'ros2 doctor' to check the ROS 2 environment setup and issues, with a specific verb and resource. It distinguishes from sibling tools which are specific actions like checking topics or calling services.

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?

It explicitly states 'No arguments needed. Just runs the doctor tool,' which implies it's a simple diagnostic to use when checking environment health. While it lacks explicit when-not-to-use or alternatives, the simplicity makes it clear.

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