retrieve_epic
Fetch details of a specific epic by providing its project and epic UUIDs.
Instructions
Retrieve an epic by ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | UUID of the project | |
| epic_id | Yes | UUID of the epic |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| deleted_at | No | ||
| created_at | No | ||
| updated_at | No | ||
| point | No | ||
| name | Yes | ||
| description | No | ||
| description_html | No | ||
| description_stripped | No | ||
| description_binary | No | ||
| priority | No | ||
| start_date | No | ||
| target_date | No | ||
| sequence_id | No | ||
| sort_order | No | ||
| completed_at | No | ||
| archived_at | No | ||
| is_draft | No | ||
| external_source | No | ||
| external_id | No | ||
| created_by | No | ||
| updated_by | No | ||
| project | Yes | ||
| workspace | Yes | ||
| parent | No | ||
| state | No | ||
| estimate_point | No | ||
| type | No | ||
| assignees | No | ||
| labels | No |
Implementation Reference
- plane_mcp/tools/epics.py:238-262 (handler)The actual handler function for the 'retrieve_epic' tool. It takes project_id and epic_id, gets the Plane client context, creates RetrieveQueryParams, and calls client.epics.retrieve().
@mcp.tool() def retrieve_epic( project_id: str, epic_id: str, ) -> Epic: """ Retrieve an epic by ID. Args: project_id: UUID of the project epic_id: UUID of the epic Returns: Epic object """ client, workspace_slug = get_plane_client_context() params = RetrieveQueryParams() return client.epics.retrieve( workspace_slug=workspace_slug, project_id=project_id, epic_id=epic_id, params=params, ) - plane_mcp/tools/epics.py:19-19 (registration)The 'register_epic_tools' function which, via the '@mcp.tool()' decorator on line 238, registers retrieve_epic as an MCP tool.
def register_epic_tools(mcp: FastMCP) -> None: - plane_mcp/tools/epics.py:243-252 (schema)The docstring/type hints that serve as the input schema: project_id (str), epic_id (str), returns Epic.
""" Retrieve an epic by ID. Args: project_id: UUID of the project epic_id: UUID of the epic Returns: Epic object """ - plane_mcp/tools/epics.py:253-262 (helper)The helper function get_plane_client_context() is called to obtain the client and workspace_slug.
client, workspace_slug = get_plane_client_context() params = RetrieveQueryParams() return client.epics.retrieve( workspace_slug=workspace_slug, project_id=project_id, epic_id=epic_id, params=params, ) - plane_mcp/tools/__init__.py:47-47 (registration)The top-level registration call: register_epic_tools(mcp) which triggers the registration of retrieve_epic along with other epic tools.
register_epic_tools(mcp)