ros2_get_topics

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

Annotations are absent, so the description carries the full burden of behavioral disclosure. 'List' strongly implies a read-only operation with no side effects, and the description does not claim any mutation. However, it does not explicitly state that it is non-destructive, does not mention whether a live ROS2 system is required, and does not describe what happens when no topics exist. This is adequate but leaves room for inference.

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?

The description is a single, well-structured sentence with no filler words. It states the action, the resource, and the additional information returned, all in one efficient line. Every part earns its place.

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 is simple (no parameters), and an output schema exists, so the description need not explain return values. However, given the absence of annotations, a short note about read-only nature or the requirement of a running ROS2 environment would improve completeness. As-is, it covers the core functionality well but is not exhaustive for a completely annotation-free tool.

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?

There are zero parameters, and the schema is empty, so the baseline for parameter semantics is 4. The description's phrase 'all available' adds meaning by indicating the tool returns a complete view of the topic graph, but because there are no parameters to elaborate on, the description does not need to compensate for any schema gaps. It appropriately represents the no-argument behavior.

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 uses a specific verb ('List') and a specific resource ('all available ROS2 topics'), and goes beyond the bare name by specifying the additional detail that publisher and subscriber nodes are included. This clearly differentiates it from sibling tools like ros2_get_nodes (lists nodes) and ros2_get_services (lists services), so an agent can select it without ambiguity.

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 gives clear context: it is for listing topics, and the mention of 'available' implies that the ROS2 graph must be reachable. It does not explicitly state exclusions such as 'use ros2_topic_echo to inspect specific message content' or 'use ros2_get_services for services', but the purpose is unambiguous enough that an agent can infer when this tool is appropriate, especially given the sibling names.

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