Skip to main content
Glama

get_project_branches

Retrieve all branches of a GitLab project using its project ID. Optionally authenticate with a personal access token for private projects.

Instructions

Get branches for a GitLab project.

Args:
    project_id: GitLab project ID
    token: GitLab Personal Access Token (optional)
    ctx: MCP context (automatically injected)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes
tokenNo
ctxNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function for the 'get_project_branches' tool. It fetches branches from a GitLab project via the GitLab API endpoint /projects/{project_id}/repository/branches, returns up to 15 branches with protected status indication.
    async def get_project_branches(project_id: int, token: str = None, ctx=None) -> str:
        """Get branches for a GitLab project.
        
        Args:
            project_id: GitLab project ID
            token: GitLab Personal Access Token (optional)
            ctx: MCP context (automatically injected)
        """
        endpoint = f"/projects/{project_id}/repository/branches"
        data = await make_gitlab_request(endpoint, ctx=ctx, token=token)
        
        if isinstance(data, dict) and "error" in data:
            return f"Error: {data['error']}"
        
        if not data:
            return "No branches found."
        
        branches = []
        for branch in data[:15]:  # Limit to 15 branches
            protected = " (protected)" if branch.get('protected') else ""
            branches.append(f"• {branch['name']}{protected}")
        
        return "\n".join(branches)
  • Registration of the get_project_branches tool using the @mcp.tool() decorator, which binds the async function to the FastMCP server.
    @mcp.tool()
  • The make_gitlab_request helper function used by get_project_branches to make API calls to GitLab with proper authentication and error handling.
    async def make_gitlab_request(endpoint: str, method: str = "GET", data: dict = None, ctx=None, token: str = None) -> dict[str, Any] | None:
        """Make a request to GitLab API with proper error handling."""
        # Priority: 1. Explicit token parameter, 2. Context headers, 3. Environment variable
        
        # If no explicit token provided, try to get from context
        if not token and ctx and hasattr(ctx, 'request_context') and ctx.request_context:
            # Try to get from request headers
            if hasattr(ctx.request_context, 'headers'):
                token = ctx.request_context.headers.get('GITLAB_TOKEN')
        
        # Fallback to environment variable
        if not token:
            token = os.getenv("GITLAB_TOKEN")
        
        if not token:
            return {"error": "GitLab token not provided. Please provide a token parameter, GITLAB_TOKEN in the request headers, or set the environment variable."}
        
        # Get GitLab URL (from context or environment)
        gitlab_url = os.getenv("GITLAB_URL", "https://gitlab.com")
        
        headers = {
            "PRIVATE-TOKEN": token,
            "Content-Type": "application/json"
        }
        
        url = f"{gitlab_url}/api/v4{endpoint}"
        
        async with httpx.AsyncClient() as client:
            try:
                if method == "GET":
                    response = await client.get(url, headers=headers, timeout=30.0)
                elif method == "POST":
                    response = await client.post(url, headers=headers, json=data, timeout=30.0)
                elif method == "PUT":
                    response = await client.put(url, headers=headers, json=data, timeout=30.0)
                elif method == "DELETE":
                    response = await client.delete(url, headers=headers, timeout=30.0)
                
                response.raise_for_status()
                return response.json() if response.content else {"success": True}
            except Exception as e:
                return {"error": str(e)}
Behavior2/5

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

With no annotations provided and a minimal description, the tool fails to disclose behaviors like authentication requirements, pagination, or return value structure beyond the function name.

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?

The description is short, front-loads the purpose, and includes a structured Args list with no unnecessary text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

While the tool is simple, the description lacks return value details despite an existing output schema, and provides no behavioral insights, making it adequate but not comprehensive.

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?

The Args section adds minimal value by stating that token is optional and ctx is auto-injected, but given 0% schema coverage, more detail would be needed to fully compensate.

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 'Get branches for a GitLab project' uses a specific verb and resource, clearly distinguishing it from sibling tools like create_branch or delete_branch.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives such as get_repository_tags or get_commits, nor any prerequisites or context for its usage.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/skmprb/gitlab-clone-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server