Skip to main content
Glama

compile

Submit an asynchronous LaTeX compile job and return immediately with its job_id (the compile keeps running on the server). Then you MUST poll compile_status with that job_id about every 5 seconds until status becomes succeeded/failed/cancelled; cancelled means the user already cancelled the job — do not keep polling and do not retry the compile. Supports xelatex, pdflatex, and lualatex (engine 'auto' honors the entry file's '% !TeX program' magic comment). SUBMITS an async job: returns job_id immediately — poll compile_status(job_id) for the outcome and pdf_url.

Input Schema

NameRequiredDescriptionDefault
engineNoauto
filenameNo
project_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does a good job: it discloses that the job is asynchronous and keeps running server-side, the recommended polling cadence, and termination semantics including the cancelled case. It does not cover failure modes on submission (e.g., missing project or invalid engine) or any limits, which keeps it short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The polling instruction is helpfully front-loaded, but the final sentence repeats the async/job_id/poll-for-outcome point already made twice earlier. Two of three sentences carry distinct value; the third is redundant padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

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 needn't be explained here, and the async control flow is fully documented. The only real hole is the semantics of the filename and project_id parameters for an agent that has only the schema's bare titles.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate; it explains the engine enum well, including that 'auto' honors the entry file's '% !TeX program' magic comment. However, project_id and filename are never explained, and filename (which likely selects the entry file) is a meaningful gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (submit an asynchronous LaTeX compile job) plus the immediate return value (job_id). It is clearly distinguishable from the sibling compile_status, which it names as the follow-up step.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit operating instructions: poll compile_status roughly every 5 seconds until succeeded/failed/cancelled, treat cancelled as the user having cancelled, and do not retry. This leaves no ambiguity about when to call this tool versus compile_status.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources