generate_bitstream

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains a nontrivial behavior: a built-in pre-check detects CRITICAL WARNING and blocks generation unless force=True is set. This goes beyond just saying 'generate' and warns the agent about a condition that could affect the outcome. It could add more about return values or side effects, but the output schema likely covers that.

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 well-structured: a brief summary sentence, a note about the safety check, and a clearly formatted Args list. It is not overly long and each part serves a purpose. The only minor redundancy is repeating defaults that already appear in the schema, but this makes the description self-contained and readable.

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 tool's complexity (bitstream generation with a safety mechanism) and that an output schema exists, the description provides adequate context. It places the tool in the implementation flow, explains the safety behavior, and covers all parameters. It does not explain what the generated bitstream is used for or what the return value contains, but the output schema is expected to handle return details.

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 schema has 0% description coverage, so the description must compensate. It does this by listing all five parameters (impl_run, jobs, timeout_minutes, force, session_id) with brief explanations and defaults. The meaning of 'force' is clarified as skipping the CRITICAL WARNING safety check, which is valuable semantic context. However, 'session_id' is only described as 'target session ID', which is somewhat vague and could benefit from more explanation.

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's function: '生成比特流文件' (generate bitstream file) and specifies when it runs ('在实现完成后执行', after implementation completes). This distinguishes it from sibling tools like run_synthesis and program_device, which operate at different stages. The verb + resource is explicit and 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?

The description gives clear timing guidance: the tool should be executed after implementation is complete. It also explains the default safety check that blocks generation on CRITICAL WARNING and how to override it with force=True. However, it does not explicitly mention alternatives or exclusions (e.g., not to use before implementation), but the context is reasonably clear.

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