Skip to main content
Glama
Sign In
Kiln

Kiln

by codeofaxel
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python

cloud_retire_remote_branch

Destructive

Retire a remote branch to mark it inactive while preserving records for audit. Use when decommissioning branches without deleting their history; requires Kiln Pro.

Instructions

Mark a remote branch retired (preserves records for audit).

Needs Kiln Pro.

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": {
      "design_id": "<design_id>",
      "branch_id": "<branch_id>"
    },
    "name": "cloud_retire_remote_branch"
  }
}

Input Schema

NameRequiredDescriptionDefault
remoteNoRemote alias, as registered with ``cloud_remote_add`` (default: ``"default"``). Default: "default".
branch_idYesThe remote branch to retire, as ``cloud_list_remote_branches`` returns it.
design_idYesThe design the branch belongs to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.5.1
    • addedInput schema / properties / branch_id / description
      Added value: +"The remote branch to retire, as ``cloud_list_remote_branches`` returns it."
    • addedInput schema / properties / design_id / description
      Added value: +"The design the branch belongs to."
    • changedInput schema / properties / remote / description
      Previous value: -"Default: \"default\"."New value: +"Remote alias, as registered with ``cloud_remote_add`` (default: ``\"default\"``). Default: \"default\"."
  2. Addedv1.5.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered. The description earns credit beyond that by clarifying the destructive scope ('preserves records for audit' – the branch is disabled, not purged) and by stating the Kiln Pro entitlement requirement, which annotations cannot express.

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, zero filler, with the state-changing action and its audit implication front-loaded before the entitlement note. Nothing could be removed without losing information.

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?

For a three-parameter, no-output-schema mutation whose annotations carry the safety signal, the description covers what the operation does, what it preserves, and the plan gate. It leaves minor gaps such as whether retirement is reversible or how retired branches surface in later listings.

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%, with each of the three parameters already documented in the schema (including the remote alias default and where branch_id comes from). The description adds no parameter-level meaning, so the baseline 3 applies.

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?

The description uses a specific verb ('Mark') plus resource ('a remote branch') plus state ('retired'), and the parenthetical '(preserves records for audit)' signals this is a soft-retire rather than a delete. It does not name a sibling such as cloud_list_remote_branches or the design/feature retire variants, so differentiation is implied by the name rather than stated.

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?

'Needs Kiln Pro' establishes a prerequisite and the notion of retiring rather than deleting implies the when, but there is no explicit when-to-use vs when-not or a pointer to an alternative (e.g. a hard delete or a branch-listing tool to find the branch_id). Usage is inferred rather than guided.

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

Deploy Server

Other Tools