Skip to main content
Glama

get_project_milestones

Retrieve milestones for a GitLab project by ID, with optional filtering by state (active, closed, all).

Instructions

Get project milestones.

Args:
    project_id: GitLab project ID
    state: Milestone state (active, closed, all)
    token: GitLab Personal Access Token (optional)
    ctx: MCP context (automatically injected)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes
stateNoactive
tokenNo
ctxNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • Handler for 'get_project_milestones' tool. Takes project_id, state (default 'active'), token, and ctx. Calls GitLab API /projects/{project_id}/milestones endpoint and returns formatted milestone list with title, state, and due date.
    @mcp.tool()
    async def get_project_milestones(project_id: int, state: str = "active", token: str = None, ctx=None) -> str:
        """Get project milestones.
        
        Args:
            project_id: GitLab project ID
            state: Milestone state (active, closed, all)
            token: GitLab Personal Access Token (optional)
            ctx: MCP context (automatically injected)
        """
        endpoint = f"/projects/{project_id}/milestones?state={state}"
        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 f"No {state} milestones found."
        
        milestones = []
        for milestone in data:
            due_date = milestone.get('due_date', 'No due date')
            milestones.append(f"• {milestone['title']} - {milestone['state']} (Due: {due_date})")
        return "\n".join(milestones)
  • Registration via @mcp.tool() decorator on the get_project_milestones function.
    # Milestones
    @mcp.tool()
    async def get_project_milestones(project_id: int, state: str = "active", token: str = None, ctx=None) -> str:
  • Helper function used by get_project_milestones to make GitLab API requests with token resolution, URL construction, 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?

No annotations are provided, and the description only lists parameters without disclosing behavioral traits such as pagination, default ordering, or whether the operation is read-only. The action 'Get' implies no side effects, but this is not explicitly stated.

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 (two lines of purpose plus parameter list). It is front-loaded with the core action. However, the docstring format with 'Args:' is slightly verbose but acceptable.

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 the existence of an output schema, return value documentation is not required. However, the description lacks information on edge cases (e.g., what happens if project_id is invalid) and does not mention any prerequisites or common pitfalls, making it sufficient 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?

Schema description coverage is 0%, so the description adds meaning by briefly explaining parameters like 'project_id: GitLab project ID' and 'state: Milestone state'. However, explanations are minimal and do not cover all nuances (e.g., valid values for state are not listed).

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 project milestones.' which is a specific verb-resource pair. It distinguishes itself from sibling tools like get_project_issues or get_project_branches by focusing solely on milestones.

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. It does not mention prerequisites, typical use cases, or when not to use it.

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