Lua即時実行

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

Disclosures go far beyond annotations: notes that print() is not captured (use log(msg)), explains globals fallback, side effects, bodies condition, and return value behavior. No contradiction with annotations.

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?

Despite length, every sentence adds necessary information. Front-loaded with purpose, then provides usage details, example, and edge cases. No wasted words.

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 one parameter, full schema coverage, and rich annotations, the description covers all needed aspects: behavior, side effects, return values, and constraints like security and physics bodies.

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 single parameter 'code' is described in schema as 'executable Lua code'. The description adds significant value: explains that globals are available, gives an example, explains return value handling. Schema coverage is 100%, but description enriches meaning.

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 it executes arbitrary Lua code in the engine's Lua state for powerful debugging. It distinguishes itself from sibling tools like dx12_describe_lua_api or dx12_read_lua_component by focusing on immediate execution.

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?

Provides detailed context on when to use: as a debug function. Mentions that side effects work in both Editor and Playing modes, but physics bodies only during Play. Also notes security model (localhost, no auth). Lacks explicit when-not-to-use or alternatives, but still strong.

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