Skip to main content
Glama

overleaf_compile

Compile an Overleaf project's LaTeX source, surface errors and warnings, and optionally save the generated PDF or raw log to local paths.

Instructions

Trigger LaTeX compilation on Overleaf, parse LaTeX errors/warnings, and optionally download the PDF.

Args: project: Overleaf project ID, project URL, or exact project title. save_pdf_path: Optional local path to save the compiled output.pdf (e.g. './paper.pdf'). save_log_path: Optional local path to save the full raw LaTeX output.log. draft: Compile in fast draft mode (skips rendering heavy figures). root_doc_path: Optional main .tex file path (e.g. 'main.tex') if overriding project default.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>"
    },
    "name": "overleaf_compile"
  }
}

Input Schema

NameRequiredDescriptionDefault
draftNo
projectYes
root_doc_pathNo
save_log_pathNo
save_pdf_pathNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose meaningful behavior: compilation runs server-side, errors and warnings are parsed, PDF download is optional, and draft mode skips rendering heavy figures. It omits what an agent most needs for a slow remote operation — expected duration/timeout, auth requirements, and what happens to project state on compile failure.

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

Conciseness4/5

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

The summary sentence is front-loaded and the Args block is a clean, scannable list where each entry adds information not in the schema. Slightly verbose with inline 'e.g.' examples, but no sentence is pure filler.

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

Completeness3/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 need not be described, and the parameters are well covered. However, for a remote compilation tool that can fail, the definition never mentions authentication prerequisites, latency, or how compile errors surface to the caller — gaps an agent would want closed before invoking it.

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

Parameters4/5

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

Schema coverage is 0%, so the description must supply all parameter meaning, and it largely does: 'project' is clarified as accepting an ID, URL, or exact title (far beyond a bare string), the two save paths are given purpose and example format, and draft/root_doc_path explain their behavioral effect. Minor gap: no note on how an ambiguous title is resolved or what the project default root doc is.

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 first sentence states a specific verb and resource ('Trigger LaTeX compilation on Overleaf') plus two concrete outcomes: error/warning parsing and optional PDF download. No sibling tool in the list compiles, so the operation is unambiguous against the read/write/upload family.

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

Usage Guidelines3/5

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

Usage is implied rather than stated — an agent can infer this is the step after editing .tex files, but there is no explicit 'use this when X, not Y' guidance and no prerequisite note (e.g. that authentication must be configured first via the auth siblings). No exclusions or failure-path guidance are given.

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