capture_topic_sync

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

With no annotations, the description must carry the burden of disclosing behavior. It adds useful context: in-memory capture, no disk I/O, and <10ms latency. But it does not disclose whether the capture is non-destructive, whether it blocks, or any side effects on the ROS system.

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 fairly concise and front-loaded with the most important information: purpose and performance. The exclamation and 'PREFERRED & FASTEST' capitalization add marketing tone but do not significantly bloat the text.

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 five parameters and no annotations, and the description omits parameter semantics and potential caveats. While an output schema exists and covers return values, the description still leaves important usage details unaddressed, making it incomplete for an agent to confidently invoke the tool correctly.

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%, and the description provides no explanation of the five parameters (topic, fields, timeout_sec, duration_sec, max_messages). The parameter names are somewhat self-explanatory, but the description does not clarify how fields filtering works or how duration/timeout interact.

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 the tool captures high-frequency topic data in memory without disk I/O, positioning it as the preferred and fastest data source for closed-loop PID tuning. It distinguishes itself from sibling tools like echo_topic and record_bag by emphasizing speed and in-memory operation, and it names the downstream analysis tools it feeds into.

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 identifies the intended use case: closed-loop PID tuning in simulation and wired setups, and instructs to pass output directly to diagnose_gimbal_tuning or analyze_gimbal_pid. However, it does not explicitly state when not to use it or name alternative capture/recording tools for comparison.

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