Skip to main content
Glama

stop_compile

DestructiveIdempotent

Stops the active Overleaf compile for a specified project and returns { stopped: true }, allowing you to halt an ongoing build.

Instructions

Stop the active Overleaf compile for a project. Returns { stopped: true }.

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": {
      "projectId": "<projectId>"
    },
    "name": "stop_compile"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdYesOverleaf project ID

Output Schema

NameRequiredDescriptionDefault
stoppedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare idempotentHint=true and destructiveHint=true, so the safety profile is partly covered. The description adds nothing about what happens with no active compile, whether partial output is discarded, or auth requirements — for a destructive/idempotent operation this leaves meaningful gaps beyond the annotations.

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?

Two short sentences, front-loaded with the action and finishing with the return shape. No wasted words.

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 fully spelled out. For a one-parameter tool this is nearly complete; the only real omission is the behavior when no compile is active, which matters given the idempotent annotation.

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?

There is a single parameter (projectId) with 100% schema description coverage, so the schema fully documents it. The description adds no extra meaning such as format, sourcing, or validation beyond what the schema provides.

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

Purpose4/5

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

"Stop the active Overleaf compile for a project" gives a specific verb (stop) and resource (active compile), clearly distinguishing it from the sibling compile_project which starts a compile. It doesn't name the sibling explicitly, but the purpose is unambiguous.

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 only implied: an agent can infer this is called to cancel a running compile. There is no explicit when-to-use statement, no guidance on what happens if no compile is running, and no mention of alternatives.

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