execute_revit_code

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

Goes meaningfully beyond the annotations: it discloses that code runs with the Windows user's permissions and can reach model data, files and network services, which explains why openWorldHint and destructiveHint are true. It does not cover failure modes, timeouts, or whether effects can be rolled back (undo_last exists as a sibling), but the added context is substantial.

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?

A single front-loaded sentence with the verb first and no filler. It is dense but every clause (permissions, capabilities) adds information rather than restating the name.

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?

An output schema exists so return values need not be described, and annotations already flag destructiveness and open-world access; the description fills the remaining gap with permission scope and capability scope. For a code-execution tool a note on isolation or side-effect permanence would complete it, but an agent has enough to call it responsibly.

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 coverage is 0%, so the description must carry the load. It does specify the code language (IronPython), which is real semantics beyond the schema's bare 'string/Code', but the optional 'description' parameter is never mentioned and no guidance is given on code structure or entry point.

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?

States a specific verb and resource: executes supplied IronPython code inside Revit. That distinguishes it from the operation-specific siblings (place_family, modify_or_delete_elements, etc.) by implication, since this is the general-purpose escape hatch, though the description never says so explicitly.

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 phrase 'after review in Revit' implies there is a review/approval gate before execution, which is useful context. But there is no explicit statement of when to prefer this over the many dedicated sibling tools (e.g. use modify_or_delete_elements instead of writing deletion code), and no when-not-to-use guidance for a destructive tool.

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