midnight_compile_contract

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

With no annotations, the description carries full burden. It discloses generated output types and a prerequisite ('Requires the compactc compiler installed locally'). It does not mention side effects, but for a compilation tool, destructive actions are unlikely. The description adds useful context beyond what annotations would provide.

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 adequately sized but has some redundancy (e.g., repeating generated items in the bullet list). It front-loads the main action but could be more streamlined. Overall, it is functional with minimal fluff.

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 compilation complexity, the description covers key outputs and a prerequisite but omits details like error handling, overwrite behavior, and output file naming. For a tool with no output schema and minimal parameter descriptions, it is moderately complete but has gaps.

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 only 33% (only source has a description). The description does not explain output_dir or contract_name beyond the implicit context of compilation. It adds some value by stating the overall process, but does not sufficiently detail parameter usage or constraints.

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: 'Compile a Compact smart contract to TypeScript bindings and ZK artifacts.' It lists specific generated outputs and distinguishes from sibling tools like midnight_deploy_contract and midnight_analyze_contract by focusing on compilation and binding generation.

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 explicitly lists use cases: 'Use this tool to: - Compile Compact source code - Generate TypeScript bindings for SDK - Prepare contracts for deployment.' It provides clear context but does not explicitly exclude cases or mention alternative tools for similar tasks.

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