generate_robot_report

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

No annotations are provided, so the description must fully disclose behavior. It only states the basic operation of generating a robot report with given parameters, but lacks details on file overwriting behavior, expected report format, execution time, or potential side effects. The return value is vaguely described as '报告生成结果'.

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 concise, using a brief purpose statement followed by a list of parameters and a return description. It is well-structured and easy to scan. However, the purpose could be more explicit about the file generation aspect.

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 description covers the basic parameters and operation but leaves gaps: the return value is vague, the report content and format are unspecified, and there is no information on permissions or long-running behavior. For a tool that generates a file, these details are important for effective use.

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 description provides brief explanations for each parameter (e.g., '机器人ID' for robot_id) which are slightly more descriptive than the schema titles. However, it does not specify expected formats, value ranges, or provide examples. With 0% schema coverage, more detail is needed.

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 states the purpose as '生成机器人运行报告' which clearly indicates generating a robot operation report. However, it does not differentiate this tool from sibling tools like analyze_robot_data or compare_robots_performance which may also produce reports. The inclusion of report_path parameter implies file generation, but this is not explicitly stated in the purpose.

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 lacks any guidance on when to use this tool versus alternatives like analyze_robot_data or compare_robots_performance. It does not mention prerequisites, typical use cases, or conditions for appropriate use.

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