Skip to main content
Glama

Get Branch Settings

get_branch_settings

Read a branch's six switches (all off by default): Receive main's email, Send email, Scheduled jobs, Receive main's realtime messages, Send realtime messages to main, Queued jobs. Lists only those the branch's code uses, as the UI does.

  • When to use: a branch sends or receives no email, its scheduled or queued jobs don't run or run twice, or realtime messages or presence aren't shared with main.

  • The user changes them in the branch's Project Settings › Advanced (branch creator or project owner). On an isolated branch, scheduled_jobs sets Scheduled jobs; to run one job now, call_app_function's scheduled_job.

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

Input Schema

NameRequiredDescriptionDefault
projectIdYes
scheduled_jobsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare non-read-only, non-destructive, non-open-world, so the description's job is to add context; it does add useful facts (all switches default off, output is filtered to switches the code uses). However, the framing "Read a branch's six switches" sits uneasily with readOnlyHint=false and with a scheduled_jobs parameter that apparently sets nothing or something — the description never clarifies whether invoking with that parameter can change branch state. No permission, rate-limit, or side-effect disclosure beyond the UI-owner note.

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 the concrete resource and its six switches, then structures triggers and the UI/alternate-path note as bullets, which is easy to scan. Minor waste and confusion in the trailing scheduled_jobs/isolation sentence, which mixes a parameter explanation into what reads like an unrelated caveat.

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?

No output schema exists, so the description must imply the return value; "lists only those the branch's code uses, as the UI does" partly does that but leaves the shape (map of six booleans? names?) unstated. Combined with the unresolved read-vs-set ambiguity of scheduled_jobs, the definition is not quite sufficient for a tool whose annotations hint at mutation.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the full burden, and it leaves projectId entirely unexplained (forgivable but undocumented). The one sentence touching scheduled_jobs — "On an isolated branch, scheduled_jobs sets Scheduled jobs; to run one job now, call_app_function's scheduled_job" — is ambiguous about whether the parameter selects, filters, or mutates, which is worse than silence for a boolean toggle.

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?

A precise verb+resource ("Read a branch's six switches") followed by an enumeration of the exact six switches, so the agent knows the concrete payload without opening the schema. It also tells the agent the tool returns a filtered subset ("Lists only those the branch's code uses"), which distinguishes it from a generic project-settings getter.

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?

Gives explicit symptom-based triggers (branch sends/receives no email, scheduled or queued jobs don't run or run twice, realtime/presence not shared with main) plus a named alternative for the adjacent action (call_app_function's scheduled_job to run one job now). It even says who can change the underlying value in the UI (branch creator or project owner), which frames the tool as diagnostic rather than a fix path.

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