Skip to main content
Glama

Start a setup run

start_setup_run

Start a setup run: a group of changes that undo_setup_run (or the customer, in the dashboard) reverts in one step. Returns run_id; pass it to every create_, update_, rename_, delete_, add_, remove_, resolve_, ignore_, reopen_ and save_ call that belongs together, so one undo covers the whole setup. Before changing anything call get_project (slots_left: how many rules, funnels, dashboards and widgets the plan still allows) and read what exists already (list_feature_rules, list_funnels, list_dashboards, list_click_problems), so a second pass updates instead of duplicating.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "start_setup_run"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindNosetup (default) for a deliberate setup pass, chat for a change asked for in conversation.
labelNoA few words the customer will see in the list of runs, e.g. Initial setup.
projectNoProject ID, from list_projects. Required when this connection covers more than one project; may be left out when it covers one (and with an API key, which belongs to one project).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations declare readOnlyHint=false, idempotentHint=false and destructiveHint=false but say nothing about reversibility; the description supplies that key trait, that the entire group of changes is reverted in one step by undo_setup_run or by the customer in the dashboard. It also discloses the return value ('Returns run_id') with no output schema present, and explains the contract for propagating that id, which is actionable behavior 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.

Conciseness4/5

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

Purpose and undo semantics are front-loaded, and every clause carries operational information (prerequisites, id propagation, duplicate avoidance). It is slightly dense — a single long paragraph with a long enumeration of create_/update_/rename_/... prefixes — but no sentence is filler.

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 run-scoping tool with no output schema, the description covers everything an agent needs: what a run is, how it is reverted, what it returns, how to propagate the id, and the read-before-write preconditions with named list tools. Nothing material is missing for correct invocation and sequencing.

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?

Schema description coverage is 100% and all three parameters (kind, label, project) are already documented in-schema with defaults and conditions, so the description does not need to compensate. It adds no param-level detail beyond the schema — its extra content is about the returned run_id rather than the inputs — so the baseline of 3 applies.

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 specific verb and resource ('Start a setup run') and immediately defines the otherwise-abstract concept: 'a group of changes that undo_setup_run (or the customer, in the dashboard) reverts in one step.' It also names the sibling tool that reverses it, so the agent can distinguish start from undo without opening a schema.

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 preconditions and alternatives: call get_project first for slots_left, and read existing state via list_feature_rules, list_funnels, list_dashboards, list_click_problems 'so a second pass updates instead of duplicating.' It also prescribes exactly which subsequent calls should carry the run_id, which is operative when-to-use guidance rather than vague context.

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