read_topic

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

With no annotations, the description must disclose behavioral traits but only states the core action. It does not address whether the tool blocks for a new message, errors on nonexistent topics, handles uninitialized topics, or requires a running ROS2 environment. This minimal statement leaves many behavioral aspects ambiguous.

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, front-loaded sentence that conveys the essential purpose with no wasted words. It is appropriately sized for the tool's low complexity.

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 no output schema and minimal annotations, the description should explain return values and failure modes, but it only mentions 'read the latest value'. It does not specify the return format, how errors are reported, or what happens if no value is available. The tool's low complexity does not fully compensate for these gaps.

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%, so the description needs to elaborate on the 'topic' parameter. It adds only the qualifier 'ROS2' but does not explain expected format (e.g., fully qualified name) or provide any additional context. The description adds minimal value beyond the parameter name and type.

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 'read' with a clear resource 'ROS2 topic', making the tool's function immediately understandable. It distinguishes from sibling tools like list_topics (list vs read) and call_service (different operation).

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?

No guidance is provided on when to use this tool versus alternatives. The description is purely declarative and lacks any mention of alternatives or exclusion criteria for when a different tool (e.g., list_topics or call_service) would be appropriate.

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