Skip to main content
Glama

branch.register

Record a branch's lineage by hand (for environments created before lineage was automatic): the parent's current schema becomes the fork base. POST /v1/organizations/{id}/projects/{project}/branches.

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": {
      "organization_id": "<organization_id>",
      "project_id": "<project_id>",
      "branch_id": "<branch_id>",
      "confirm": "<confirm>"
    },
    "name": "branch.register"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmYesMust be true to apply this mutation; otherwise the tool returns the request it would send for approval.
branch_idYesbranch_id (required)
project_idYesproject_id (required)
organization_idYesorganization_id (required)
parent_environment_idNoParent environment the branch was cut from

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare the mutation profile (readOnly=false, destructive=false, idempotent=false, openWorld=false), so the safety bar is lower. The description adds genuine semantic context about what the call establishes (the fork base from the parent's current schema), but says nothing about re-registering an already-linked branch, overwrite behavior, or required permissions.

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?

Two compact clauses, with the purpose and the applicability condition front-loaded before the endpoint path. The trailing POST path largely restates the naming convention already visible in the tool name and schema, but it costs little.

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 mutation with full annotation coverage, a fully documented 5-parameter schema, and no output schema, the description supplies the essential why and when plus the semantic effect. Remaining gaps (idempotency on repeat registration, error cases) are minor and not required to invoke it correctly.

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%, so the schema already documents all five parameters, including the confirm gate and parent_environment_id. The description adds only indirect meaning by explaining that the parent's current schema becomes the fork base; it offers no format or selection guidance for organization_id, project_id, or branch_id beyond the schema.

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?

States a specific verb and resource ('Record a branch's lineage by hand') plus the concrete effect ('the parent's current schema becomes the fork base'), which is much more than the name alone conveys. It implicitly separates itself from automatic lineage tracking, but never names the sibling it competes with (e.g. branches.create), so an agent must still infer which creation path to pick.

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 an explicit applicability condition: 'for environments created before lineage was automatic'. That is a real when-to-use signal. It stops short of a when-not rule or a named alternative, so it is clear context rather than full routing guidance.

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