compile_presentation

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

With no annotations provided, the description carries the full burden. It discloses that the tool writes directly to an absolute output_path, compiles the in-memory presentation, and distinguishes PDF vs PPTX behavior. However, it doesn't mention whether existing files are overwritten, permission requirements, potential errors (e.g., missing lualatex), or side effects beyond file creation.

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 compact and well-structured, with the main action and follow-up step in two sentences, followed by a tight parameter list. No wasted words; every line 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?

For a tool with 6 parameters and no annotations, the description covers the core workflow, output formats, and parameter constraints. The presence of an output schema reduces the need to explain return values. However, the missing presentation_id explanation and lack of error/overwrite behavior keep it from being fully complete.

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 description coverage is 0%, so the description must explain parameters. It does explain output_path (absolute), format ('pdf' or 'pptx'), theme (Beamer theme, PDF only, default 'moloch'), highlight_style (default 'tango'), and reference_doc (pptx template, optional). The required presentation_id is omitted, but all other parameters receive meaningful context beyond their raw schema types.

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 uses a specific verb ('Compile') and resource ('the in-memory presentation') while specifying the output formats (PDF or PPTX) and destination. It clearly distinguishes itself from sibling tools like export_presentation_source (source export) and render_slides_as_pngs (image rendering).

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 explicitly advises calling render_slides_as_pngs afterwards for visual validation, and gives format-specific constraints (theme for PDF only, reference_doc for PPTX only). However, it doesn't explicitly state when to choose this tool over alternatives like export_presentation_source, leaving some room for ambiguity.

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