get_topic_info

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

No annotations are provided, so the description carries the full transparency burden. The verb 'Inspect' clearly indicates a read-only operation with no side effects, and the description lists the exact information returned (msg_type, publishers, subscribers), which is valuable behavioral disclosure. It lacks caveats about failure modes, but for a simple read tool this is sufficient.

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 sentence that is concise and front-loaded. It states the action, the resource, and the key details without unnecessary fluff. The phrase 'via pure Rosbridge WebSocket API' is a minor addition but does not detract from overall conciseness.

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 the simple one-parameter nature and the presence of an output schema, the description is fairly complete. It covers what the tool does and what information it provides. It could mention prerequisites like a running ROS environment, but the absence is not critical for a straightforward inspection 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?

Schema description coverage is 0%, so the description must compensate for the parameter. It does not provide any additional detail about the 'topic' parameter beyond its name; it only says 'topic details' without specifying format, examples, or valid values. The parameter name is self-explanatory, but the description adds no meaning beyond the schema.

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 a specific verb ('Inspect') and resource ('ROS topic details'), and distinguishes itself from siblings by enumerating the exact output fields (msg_type, publishers, subscribers). This contrasts with echo_topic (streaming data) and list_topics (listing all topics), making the tool's purpose unambiguous.

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?

There is no explicit guidance on when to use this tool versus alternatives. The description does not mention that list_topics is for enumerating topics or that echo_topic is for subscribing to data, leaving the agent to infer the appropriate context from sibling names.

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