get_issue_using_readable_identifier
Retrieve specific project issues by providing a project identifier (e.g., FIRST) and issue identifier (e.g., 123) using the Plane MCP Server.
Instructions
Get all issues for a specific project. When issue identifier is provided something like FIRST-123, ABC-123, etc. For FIRST-123, project_identifier is FIRST and issue_identifier is 123
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| issue_identifier | Yes | The identifier of the issue to get | |
| project_identifier | Yes | The readable identifier of the project to get issues for |
Implementation Reference
- src/tools/issues.ts:109-122 (handler)The core handler logic that takes project_identifier and issue_identifier, constructs the readable issue path, fetches the issue using makePlaneRequest, and returns it as JSON text content.
async ({ project_identifier, issue_identifier }) => { const issue = await makePlaneRequest( "GET", `workspaces/${process.env.PLANE_WORKSPACE_SLUG}/issues/${project_identifier}-${issue_identifier}/` ); return { content: [ { type: "text", text: JSON.stringify(issue, null, 2), }, ], }; } - src/tools/issues.ts:105-108 (schema)Zod input schema validating project_identifier and issue_identifier parameters.
{ project_identifier: z.string().describe("The readable identifier of the project (e.g., 'FIRST' for FIRST-123)"), issue_identifier: z.string().describe("The issue number (e.g., '123' for FIRST-123)"), }, - src/tools/issues.ts:102-123 (registration)Direct registration of the tool via McpServer.tool() call within registerIssueTools function.
server.tool( "get_issue_using_readable_identifier", "Get a specific issue using its readable identifier. When issue identifier is provided something like FIRST-123, ABC-123, etc. For FIRST-123, project_identifier is FIRST and issue_identifier is 123", { project_identifier: z.string().describe("The readable identifier of the project (e.g., 'FIRST' for FIRST-123)"), issue_identifier: z.string().describe("The issue number (e.g., '123' for FIRST-123)"), }, async ({ project_identifier, issue_identifier }) => { const issue = await makePlaneRequest( "GET", `workspaces/${process.env.PLANE_WORKSPACE_SLUG}/issues/${project_identifier}-${issue_identifier}/` ); return { content: [ { type: "text", text: JSON.stringify(issue, null, 2), }, ], }; } ); - src/common/request-helper.ts:3-36 (helper)Helper utility function used by the tool handler to perform authenticated HTTP requests to the Plane API.
export async function makePlaneRequest<T>(method: string, path: string, body: any = null): Promise<T> { const hostUrl = process.env.PLANE_API_HOST_URL || "https://api.plane.so/"; const host = hostUrl.endsWith("/") ? hostUrl : `${hostUrl}/`; const url = `${host}api/v1/${path}`; const headers: Record<string, string> = { "X-API-Key": process.env.PLANE_API_KEY || "", }; // Only add Content-Type for non-GET requests if (method.toUpperCase() !== "GET") { headers["Content-Type"] = "application/json"; } try { const config: AxiosRequestConfig = { url, method, headers, }; // Only include body for non-GET requests if (method.toUpperCase() !== "GET" && body !== null) { config.data = body; } const response = await axios(config); return response.data; } catch (error) { if (axios.isAxiosError(error)) { throw new Error(`Request failed: ${error.message}`); } throw error; } } - src/tools/index.ts:20-20 (registration)Top-level registration call to registerIssueTools(server), which includes the get_issue_using_readable_identifier tool, invoked from the main registerTools function.
registerIssueTools(server);