Skip to main content
Glama

get_branch

Read-only

Retrieves details for a specific GitLab branch, including commit information and protection status, to verify branch configuration and security settings.

Instructions

Get branch details (commit, protection status). To find resources, use the matching list or search tool.

Input Schema

NameRequiredDescriptionDefault
jmespathNoOptional JMESPath expression filtering the JSON result before return.
project_idYesProject ID or complete URL-encoded path to project
branch_nameYesName of the branch

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.66
    • addedInput schema / properties / jmespath
      Added value: +{
      +  "description": "Optional JMESPath expression filtering the JSON result before return.",
      +  "type": "string"
      +}
  2. Changed1 schema field changedv2.1.62
    • changedInput schema / required
      Previous value: -[
      -  "branch_name",
      -  "project_id"
      -]New value: +[
      +  "project_id",
      +  "branch_name"
      +]
  3. Addedv2.1.18
  4. Removedv2.1.14
  5. Addedv2.1.12

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety profile is covered by structured data. The description adds that the result contains commit and protection status, which is useful context, but says nothing about permissions, error behavior, or response shape beyond those two fields.

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, no filler, with the core purpose front-loaded before the disambiguation hint. Every clause earns its place.

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 simple read-only single-resource fetch with fully documented parameters and readOnlyHint annotations, the description covers purpose plus partial return content. No output schema exists, so a slightly fuller account of the returned object would help, but it is close to complete.

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 project_id, branch_name, and the jmespath filter are all documented in the schema itself. The description adds no additional parameter meaning, which is the expected baseline when the schema does the work.

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+resource ("Get branch details") and enumerates the returned fields (commit, protection status), which distinguishes it from mutation tools like update_merge_request. It does not explicitly name the sibling list_branches, so differentiation is only implied.

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?

The second sentence routes the agent to "the matching list or search tool" when it needs to find resources, which sets a usage boundary. However, it never names list_branches or any concrete alternative, so the routing guidance is generic and requires the agent to infer the sibling.

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