Skip to main content
Glama

update_project_settings

Idempotent

Persist a project's root document, TeX engine, TeX Live image, or spell-check language in Overleaf's project settings so the web UI Recompile uses the change.

Instructions

Persist the project's root document, TeX engine, TeX Live image, or spell-check language in Overleaf's own project settings, so the web UI's Recompile follows the change. rootFilePath must name an existing .tex, .ltx, .Rtex, or .Rnw document; any other extension is INVALID_ARGUMENT before any request. Settings are applied one request at a time; if one fails, the error keeps its code, lists the settings already stored in details.applied and the failed one in details.failed, and no later setting is sent. Returns the settings as re-read from the project. Provide at least one field.

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": "update_project_settings"
  }
}

Input Schema

NameRequiredDescriptionDefault
compilerNo
imageNameNoTeX Live image, as shown in Overleaf's menu
projectIdYesOverleaf project ID
rootFilePathNoDocument Overleaf should compile by default: .tex, .ltx, .Rtex, or .Rnw
spellCheckLanguageNoOverleaf language code such as en or de; an empty string turns spell checking off

Output Schema

NameRequiredDescriptionDefault
compilerNo
imageNameNo
projectIdYes
rootDocPathNo
spellCheckLanguageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the idempotentHint/destructiveHint annotations: per-request sequential application, fail-fast with details.applied and details.failed and a preserved error code, and validation that short-circuits with INVALID_ARGUMENT before any request. That partial-failure contract is exactly what an agent needs to plan a multi-field update.

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?

Front-loads what is persisted, then the validation rule, then the failure contract, which is a sensible order. It is dense but nearly every sentence carries operational information; the closing note that it returns re-read settings is slightly redundant given an output schema exists.

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 a five-parameter mutation tool, the description covers validation, ordering, partial-failure reporting, and return semantics. With an output schema present, no further detail on the response shape is required.

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 80%, so most parameters are already documented; the description still adds real value by giving the allowed rootFilePath extensions and the cross-field constraint that at least one field must be supplied (the schema only requires projectId). It says nothing extra about compiler, imageName, or spellCheckLanguage beyond the schema.

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 precise verb (persist) and resource (Overleaf project settings) plus the four concrete fields it governs: root document, TeX engine, TeX Live image, spell-check language. It is clearly a settings mutation, distinguishable from compile_project or create_project in the sibling list.

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

Usage Guidelines4/5

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

Gives a clear reason to use it: so the web UI's Recompile follows the change, implying persistent project configuration rather than a one-off compile. It does not state when not to use it or contrast with a sibling such as compile_project, so it stops short of full routing guidance.

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