Skip to main content
Glama
goto-software

plane-mcp-server

list_milestones

List all milestones in a project by providing the project UUID. Optionally filter results with query parameters.

Instructions

List all milestones in a project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesUUID of the project
paramsNoOptional query parameters as a dictionary

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • Handler function for the 'list_milestones' tool. Calls client.milestones.list() with the workspace slug and project ID, returning the results list from the paginated response.
    @mcp.tool()
    def list_milestones(
        project_id: str,
        params: dict[str, Any] | None = None,
    ) -> list[Milestone]:
        """
        List all milestones in a project.
    
        Args:
            project_id: UUID of the project
            params: Optional query parameters as a dictionary
    
        Returns:
            List of Milestone objects
        """
        client, workspace_slug = get_plane_client_context()
        response: PaginatedMilestoneResponse = client.milestones.list(
            workspace_slug=workspace_slug, project_id=project_id, params=params
        )
        return response.results
  • Imports the Milestone and PaginatedMilestoneResponse schemas used by list_milestones.
    from plane.models.milestones import (
        CreateMilestone,
        Milestone,
        MilestoneWorkItem,
        PaginatedMilestoneResponse,
        PaginatedMilestoneWorkItemResponse,
        UpdateMilestone,
    )
  • The tool is registered via the @mcp.tool() decorator in register_milestone_tools().
    @mcp.tool()
    def list_milestones(
  • The register_milestone_tools function is imported and called in the top-level register_tools() to wire up the milestone tools.
    from plane_mcp.tools.milestones import register_milestone_tools
    from plane_mcp.tools.modules import register_module_tools
    from plane_mcp.tools.pages import register_page_tools
    from plane_mcp.tools.projects import register_project_tools
    from plane_mcp.tools.states import register_state_tools
    from plane_mcp.tools.users import register_user_tools
    from plane_mcp.tools.work_item_activities import register_work_item_activity_tools
    from plane_mcp.tools.work_item_comments import register_work_item_comment_tools
    from plane_mcp.tools.work_item_links import register_work_item_link_tools
    from plane_mcp.tools.work_item_properties import register_work_item_property_tools
    from plane_mcp.tools.work_item_relations import register_work_item_relation_tools
    from plane_mcp.tools.work_item_types import register_work_item_type_tools
    from plane_mcp.tools.work_items import register_work_item_tools
    from plane_mcp.tools.work_logs import register_work_log_tools
    from plane_mcp.tools.workspaces import register_workspace_tools
    
    
    def register_tools(mcp: FastMCP) -> None:
        """Register all tools with the MCP server."""
        register_project_tools(mcp)
        register_work_item_tools(mcp)
        register_work_item_activity_tools(mcp)
        register_work_item_comment_tools(mcp)
        register_work_item_link_tools(mcp)
        register_work_item_relation_tools(mcp)
        register_work_log_tools(mcp)
        register_cycle_tools(mcp)
        register_user_tools(mcp)
        register_module_tools(mcp)
        register_initiative_tools(mcp)
        register_intake_tools(mcp)
        register_label_tools(mcp)
        register_page_tools(mcp)
        register_work_item_property_tools(mcp)
        register_work_item_type_tools(mcp)
        register_state_tools(mcp)
        register_workspace_tools(mcp)
        register_epic_tools(mcp)
        register_milestone_tools(mcp)
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action. It lacks disclosure of behavioral traits like pagination, sorting, or behavior when no milestones exist, which are critical for an agent to invoke correctly.

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?

Single sentence is concise and front-loaded, but the extreme brevity leaves out useful details. Could be expanded slightly without losing efficiency.

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 presence of an output schema and the simplicity of listing, the description is adequate but not complete. It fails to explain the role of the 'params' parameter or any filtering constraints, leaving gaps for an agent.

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 covers both parameters fully (100% coverage). Description adds no extra meaning beyond what the schema provides, so baseline of 3 is appropriate. The 'params' parameter remains vague even in schema, yet the description does not clarify it.

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?

Description uses specific verb 'list' and resource 'milestones' with scope 'in a project', clearly distinguishing from sibling tools like 'list_milestone_work_items' which list items within a milestone.

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 description implies use for listing all milestones in a project but provides no explicit guidance on when to use this tool versus alternatives such as 'list_milestone_work_items' or other list tools, nor any exclusions.

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/goto-software/plane-mcp-server'

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