compile_project

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

Annotations already indicate the operation is not read-only, not idempotent, and not destructive, so the description doesn't need to restate those. It does add the requirement TYPLEAF_SESSION and the engine dependency, but it does not disclose potential side effects like overwriting files, whether compilation is synchronous, or how failures are reported—gaps the annotations don't fill. The description adds some value but not rich behavioral context.

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?

Three sentences with no filler: the action, the return value, the engine source, and a prerequisite are all front-loaded. Every sentence earns its place without redundancy.

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?

For a compilation trigger, the description covers the core action, return type, and engine selection. It omits potential asynchronicity, error behavior, or how to retrieve logs (download_log exists), and there is no output schema to fall back on. Still, for a simple trigger it is largely sufficient, so a 4 is warranted.

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 schema description for project_id is 100% covered and highly detailed (format, how to obtain, what not to use). The tool description does not add any additional parameter semantics beyond the schema, so with high schema coverage the baseline of 3 is appropriate.

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 ('Trigger PDF compilation') with a specific resource ('on Typleaf') and explicitly lists the output ('compilation status and output file list'). It also distinguishes itself from the sibling set_compiler by noting the engine comes from the project's compiler setting, so an agent can tell them apart.

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?

It points to set_compiler as the source of the engine, implying set_compiler is used for that purpose, and states it works for both Typst and LaTeX. However, it does not explicitly contrast with local file-reading tools or download_pdf, though the parameter schema (not the description) covers when to avoid remote tools. The description itself gives decent context but not exhaustive exclusions.

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