Skip to main content
Glama
zereight

gitlab mcp

by zereight
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_branch

Read-only

Retrieve commit and protection details for a specific GitLab branch using its project and branch name.

Instructions

Get branch details (commit, protection status). Use this for a known resource or result; choose the corresponding list or search tool when you need to discover multiple resources. It is read-only and does not mutate GitLab data; missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Input Schema

TableJSON 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

A4.3/5.0
Behavior4/5

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

Annotations declare readOnlyHint=true, and the description reinforces this with 'read-only and does not mutate GitLab data'. It adds useful behavioral context beyond annotations by listing error conditions: 'missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors.'

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?

The description is front-loaded with the purpose and usage guidance, and each sentence contributes. The final sentence is somewhat generic boilerplate about identifiers and pagination that could be trimmed, but overall it is concise.

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?

The description covers when to use, safety, errors, and identifier format. With no output schema, it gives a hint of return content ('commit, protection status') but doesn't enumerate all fields. Still, for a simple get-one-resource tool, this is sufficiently 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%; the description adds no new meaning for branch_name or jmespath. It repeats the project_id format ('numeric ID or complete URL-encoded path') that the schema already documents, so it stays at the baseline of 3.

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?

The description opens with a specific verb and resource: 'Get branch details (commit, protection status)'. It also distinguishes from discovery tools by stating this is for a known resource or result, making it clear which sibling tools (list_branches, search) are alternatives.

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?

Explicitly states when to use the tool versus alternatives: 'Use this for a known resource or result; choose the corresponding list or search tool when you need to discover multiple resources.' This removes ambiguity and routes the agent to the appropriate sibling.

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