get_module
Retrieve detailed information about a specific module within a project using its unique identifiers for project and module management within the Plane MCP Server.
Instructions
Get details of a specific module
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| module_id | Yes | The uuid identifier of the module to get | |
| project_id | Yes | The uuid identifier of the project containing the module |
Implementation Reference
- src/tools/modules.ts:37-50 (handler)Handler function for the get_module tool. It makes a GET request to the Plane API to retrieve details of a specific module and returns the response as formatted JSON text.
async ({ project_id, module_id }) => { const response = await makePlaneRequest( "GET", `workspaces/${process.env.PLANE_WORKSPACE_SLUG}/projects/${project_id}/modules/${module_id}/` ); return { content: [ { type: "text", text: JSON.stringify(response, null, 2), }, ], }; } - src/tools/modules.ts:33-36 (schema)Input schema for the get_module tool, defining required string parameters project_id and module_id using Zod.
{ 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"), }, - src/tools/modules.ts:30-51 (registration)Registration of the get_module tool using McpServer.tool(), including name, description, input schema, and inline handler function.
server.tool( "get_module", "Get details of 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"), }, async ({ project_id, module_id }) => { const response = await makePlaneRequest( "GET", `workspaces/${process.env.PLANE_WORKSPACE_SLUG}/projects/${project_id}/modules/${module_id}/` ); return { content: [ { type: "text", text: JSON.stringify(response, null, 2), }, ], }; } ); - src/common/request-helper.ts:3-36 (helper)Helper utility function makePlaneRequest used by the get_module handler to perform authenticated HTTP requests to the Plane API via axios.
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; } }