Skip to main content
Glama

Compile a project PDF

compile_pdf

Compile a PDF from server-saved project files using the project's compiler settings and an explicit entry .tex path. Use when the user asks to compile or needs a current PDF, not automatically after every source edit. Requires compile:run and Owner/Editor access. Reuses identical cached PDFs or active jobs, otherwise queues a new job under existing limits. Returns immediately without waiting for compilation. Use read_pdf with the returned jobId for progress and the PDF. Creates a job/artifact and history checkpoints without changing source files or deleting previous artifacts; no public publication or external recipients.

Input Schema

NameRequiredDescriptionDefault
pathYesProject-relative entry .tex path, such as main.tex.
projectIdYes

Output Schema

NameRequiredDescriptionDefault
jobIdYes
statusYes
messageYes
mainPathYes
dispositionYes
retryAfterSecondsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior5/5

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

The description adds substantial behavior beyond the annotations: required compile:run and Owner/Editor access, caching and active-job reuse, queueing under existing limits, and immediate return without waiting. It also clarifies side effects, stating that it creates job/artifact/history checkpoints without changing source files or deleting artifacts, and that it does not publish publicly or send to external recipients.

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

Conciseness5/5

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

The description is dense but front-loaded, starting with the core action and entry path before moving into usage, permissions, caching, async behavior, and side effects. Every sentence contributes operational context that helps an agent invoke the tool correctly.

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

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an asynchronous compilation tool with an output schema, the description covers the essential context: permissions, caching/reuse behavior, queueing, immediate return, follow-up via read_pdf, and side-effect boundaries. It is complete enough for an agent to understand both how to call it and what will happen after calling it.

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?

The schema already documents the path parameter, and the description reinforces it as an explicit entry .tex path. The projectId parameter has no schema description, and the description only implies project context through phrases like server-saved project files and project compiler settings rather than explaining the projectId parameter directly.

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?

The description states a specific verb and resource: compile a PDF from server-saved project files using project compiler settings and an explicit entry .tex path. It clearly distinguishes this from read_pdf by explaining that compile_pdf starts the job while read_pdf is used for progress and retrieving the PDF.

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?

It gives explicit when-to-use guidance: when the user asks to compile or needs a current PDF. It also explicitly rules out automatic use after every source edit and names read_pdf as the follow-up tool for progress and results.

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