list_module_issues
Retrieve all issues associated with a specific module in a project using the project and module UUID identifiers. Ideal for managing and analyzing module-related tasks within Plane's project management system.
Instructions
Get all issues for a specific module
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| module_id | Yes | The uuid identifier of the module to get issues for | |
| project_id | Yes | The uuid identifier of the project containing the module |
Implementation Reference
- src/tools/module-issues.ts:14-27 (handler)The handler function that executes the tool: makes a GET request to the Plane API for module issues and returns the JSON response as text content.
async ({ project_id, module_id }) => { const response = await makePlaneRequest( "GET", `workspaces/${process.env.PLANE_WORKSPACE_SLUG}/projects/${project_id}/modules/${module_id}/module-issues/` ); return { content: [ { type: "text", text: JSON.stringify(response, null, 2), }, ], }; } - src/tools/module-issues.ts:10-13 (schema)Input schema defined with Zod for project_id and module_id parameters.
{ project_id: z.string().describe("The uuid identifier of the project containing the module"), module_id: z.string().describe("The uuid identifier of the module to get issues for"), }, - src/tools/module-issues.ts:7-28 (registration)Registration of the list_module_issues tool on the MCP server, including schema and handler.
server.tool( "list_module_issues", "Get all issues for a specific module", { project_id: z.string().describe("The uuid identifier of the project containing the module"), module_id: z.string().describe("The uuid identifier of the module to get issues for"), }, async ({ project_id, module_id }) => { const response = await makePlaneRequest( "GET", `workspaces/${process.env.PLANE_WORKSPACE_SLUG}/projects/${project_id}/modules/${module_id}/module-issues/` ); return { content: [ { type: "text", text: JSON.stringify(response, null, 2), }, ], }; } ); - src/tools/index.ts:19-19 (registration)Invocation of registerModuleIssueTools within the main registerTools function.
registerModuleIssueTools(server); - src/common/request-helper.ts:3-36 (helper)Helper function makePlaneRequest used by the handler to make 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; } }