compile_reportCompile the configured Overleaf project and save the generated PDF to your workspace.
Compile the configured remote project and save its PDF inside the configured workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| root_document | No |
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| nextActions | Yes | ||
| workflowState | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate idempotent, non-readOnly, and non-destructive behavior. The description adds the useful side effect of saving the PDF in the workspace, but it does not explain overwrite behavior, remote compilation delays, failure modes, or access requirements. It minimally extends what annotations already provide.
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 a single concise sentence with the primary action and side effect front-loaded. There is no filler, and the minor repetition of 'configured' does not hurt clarity.
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?
An output schema and annotations cover return values and safety, but the definition is incomplete for a compile tool: the only parameter is undocumented, and the relationship to the publishing workflow is unclear. An agent cannot confidently determine when to call it or what root_document should be.
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?
The sole parameter root_document is entirely unexplained, and schema description coverage is 0%. The description never mentions what root_document should contain, whether it selects a subfile, or how it interacts with the configured project, so the agent receives no semantic help for the parameter.
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 clearly states the action ('Compile'), the object ('configured remote project'), and the outcome ('save its PDF inside the configured workspace'). It distinguishes the tool from list/read siblings, though it leaves the title's 'download' aspect ambiguous and does not explicitly contrast with preview_publish or confirm_publish.
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?
There is no guidance on when to use this tool versus siblings like preview_publish, confirm_publish, or read_report_file. It also does not mention prerequisites such as an active edit session or how the workspace is configured, so usage context is left entirely implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.