compile_and_preview

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

It describes the two operational modes and the return type (image or error JSON), but lacks details on output format (e.g., MIME type), side effects (e.g., file saving), or error handling specifics. With no annotations, the description carries the burden but is only partially transparent.

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 short and well-structured: it opens with the main purpose, explains the two modes, then lists parameters and return value. Every sentence adds value 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 moderate-complexity tool with no output schema, the description covers the core logic but fails to specify the format of the returned image or the nature of error returns. This leaves gaps for agent invocation, given the available sibling tools.

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?

With 0% schema description coverage, the description fully explains each parameter: tex_path behavior, output_filename default, template_name examples, and dpi default. This adds significant meaning beyond the bare schema, though enum values for templates could be more explicit.

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 starts with a clear action: 'Compile a LaTeX resume to PDF and return a preview image.' This distinguishes it from sibling tools like generate_resume or browse_overleaf_templates, which focus on generation or browsing.

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 explains two paths based on tex_path but does not provide explicit guidance on when to use this tool versus alternatives like generate_resume or generate_tailored_resume. Usage is implied but not fully clarified.

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