Skip to main content
Glama

get_project

Retrieve detailed information about a GitLab project using its project ID.

Instructions

Get detailed information about a specific 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 `get_project` tool handler function. It calls GitLab API `GET /projects/{project_id}` and formats a detailed response with project info (name, path, description, visibility, default branch, dates, stars, forks, issues, URL). Decorated with @mcp.tool() which serves as both registration and handler definition.
    @mcp.tool()
    async def get_project(project_id: int, token: str = None, ctx=None) -> str:
        """Get detailed information about a specific project.
        
        Args:
            project_id: GitLab project ID
            token: GitLab Personal Access Token (optional)
            ctx: MCP context (automatically injected)
        """
        data = await make_gitlab_request(f"/projects/{project_id}", ctx=ctx, token=token)
        
        if isinstance(data, dict) and "error" in data:
            return f"Error: {data['error']}"
        
        result = f"Project: {data['name']} (ID: {data['id']})\n"
        result += f"Path: {data['path_with_namespace']}\n"
        result += f"Description: {data.get('description', 'No description')}\n"
        result += f"Visibility: {data['visibility']}\n"
        result += f"Default Branch: {data['default_branch']}\n"
        result += f"Created: {data['created_at']}\n"
        result += f"Last Activity: {data['last_activity_at']}\n"
        result += f"Stars: {data['star_count']} | Forks: {data['forks_count']}\n"
        result += f"Issues: {data['open_issues_count']} open\n"
        result += f"URL: {data['web_url']}"
        
        return result
  • Input schema definition via the function signature: accepts project_id (int, required), token (str, optional), ctx (MCP context, auto-injected).
    async def get_project(project_id: int, token: str = None, ctx=None) -> str:
        """Get detailed information about a specific project.
        
        Args:
            project_id: GitLab project ID
            token: GitLab Personal Access Token (optional)
            ctx: MCP context (automatically injected)
        """
  • Tool registration via `@mcp.tool()` decorator on line 1097, which registers 'get_project' with the FastMCP server instance.
    @mcp.tool()
    async def get_project(project_id: int, token: str = None, ctx=None) -> str:
        """Get detailed information about a specific project.
        
        Args:
            project_id: GitLab project ID
            token: GitLab Personal Access Token (optional)
            ctx: MCP context (automatically injected)
        """
        data = await make_gitlab_request(f"/projects/{project_id}", ctx=ctx, token=token)
  • The `make_gitlab_request` helper function used by `get_project` to make the actual HTTP GET request to GitLab API.
    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, the description carries full burden but only says 'Get detailed information,' offering no insight into behavioral traits like permissions, side effects, or throttling. Minimal transparency.

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 concise, with one line for purpose and an args list. It is efficient, though the args list could be integrated more cleanly.

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?

Given an output schema exists, the description does not need to detail return values. However, it lacks context on what 'detailed information' entails and how to use the optional token, making it adequate but not 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?

The description adds meaning to parameters ('GitLab project ID' for project_id, 'optional' for token) beyond the schema names. However, the ctx parameter is unexplained, and with 0% schema coverage, it should do more.

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 clearly states 'Get detailed information about a specific project,' providing a specific verb and resource. It effectively distinguishes itself from sibling tools like create_project or delete_project.

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?

No guidance is provided on when to use this tool versus alternatives. There is no mention of context, prerequisites, or exclusions, leaving the agent without decision support.

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