litex_soc

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

With no annotations provided, the description carries full burden but only mentions returns ('logs and output directory') and the 'without building gateware' constraint. It lacks details on permissions, rate limits, error handling, or what 'Generate' entails operationally (e.g., configuration files, scripts). More behavioral context is needed for a tool with potential side effects.

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 two concise sentences with zero waste: first states the purpose and key constraint, second specifies returns. It's front-loaded with the main action and efficiently structured.

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 annotations and no output schema, the description is minimal but covers basics: purpose, constraint, and returns. For a 4-parameter tool that likely involves system operations (generating SoC configurations), it should provide more context on behavior, outputs, or integration with siblings to be fully complete.

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 100%, so the schema fully documents parameters. The description adds no additional parameter semantics beyond what's in the schema (e.g., no examples of 'board' values or 'args' usage). Baseline 3 is appropriate as the schema handles parameter documentation adequately.

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 action ('Generate LiteX SoC') and resource ('LiteX SoC'), specifying it's 'without building gateware'. It distinguishes from sibling 'litex_build' by emphasizing no gateware building, but doesn't explicitly contrast with other siblings like 'litex_flow' or 'synthesize'.

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 implies usage for generating SoC configurations without full hardware implementation, suggesting when to use it (vs. building gateware). However, it doesn't provide explicit alternatives or exclusions, nor guidance on when to choose this over other siblings like 'litex_flow' or 'synthesize'.

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