yade_execute_task

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

Without annotations, the description carries the full burden. It discloses asynchronous behavior, immediate task_id return, background execution, and intended use for long-running tasks. It does not delve into authentication, rate limits, or potential side effects, but the provided details are sufficient for understanding the tool's behavior.

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 with no redundant sentences. It is well-structured: first sentence introduces the action, second explains async behavior, third lists companion tools, and fourth and fifth provide usage guidance and alternatives. Every sentence adds value.

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 tool's purpose, behavior, lifecycle management (via companion tools), and usage scenarios. Since an output schema exists, the lack of return value details is acceptable. The description is comprehensive for an agent to correctly select and invoke the 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?

The input schema covers 100% of parameters with descriptions. The description adds meaning beyond the schema: it specifies that the script is Python, execution is asynchronous, and a task_id is returned. This context helps the agent understand the execution model without relying solely on 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 the tool's purpose: 'Submit a Python script for asynchronous execution in YADE'. It specifies the resource (Python script) and action (submit for execution), and distinguishes from siblings by noting companion tools and contrasting with yade_execute_code for quick queries.

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?

Explicit guidelines are provided: 'Use this for production simulation runs, long O.run() cycles, and any operation that may take minutes or longer. For quick queries and REPL-style testing, use yade_execute_code.' It also lists companion tools for lifecycle management, leaving no ambiguity about when to use this tool.

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