list_modules
Retrieve all modules in a specified project by providing the project ID. Optional parameters allow filtering or pagination for targeted results.
Instructions
List all modules in a project.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | UUID of the project | |
| params | No | Optional query parameters as a dictionary |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- plane_mcp/tools/modules.py:23-43 (handler)The actual handler function for the 'list_modules' tool. Decorated with @mcp.tool() and defined inside register_module_tools. Calls client.modules.list() with workspace_slug, project_id, and optional params, returning results from a PaginatedModuleResponse.
@mcp.tool() def list_modules( project_id: str, params: dict[str, Any] | None = None, ) -> list[Module]: """ List all modules in a project. Args: workspace_slug: The workspace slug identifier project_id: UUID of the project params: Optional query parameters as a dictionary Returns: List of Module objects """ client, workspace_slug = get_plane_client_context() response: PaginatedModuleResponse = client.modules.list( workspace_slug=workspace_slug, project_id=project_id, params=params ) return response.results - plane_mcp/tools/modules.py:7-14 (schema)Imports the schema types (Module, PaginatedModuleResponse) used by list_modules for type hints and return types.
from plane.models.modules import ( CreateModule, Module, PaginatedArchivedModuleResponse, PaginatedModuleResponse, PaginatedModuleWorkItemResponse, UpdateModule, ) - plane_mcp/tools/modules.py:20-21 (registration)The registration function that decorates list_modules with @mcp.tool() to register it with the MCP server.
def register_module_tools(mcp: FastMCP) -> None: """Register all module-related tools with the MCP server.""" - plane_mcp/tools/__init__.py:38-38 (registration)Called from register_tools() to register all module tools including list_modules.
register_module_tools(mcp) - plane_mcp/tools/modules.py:17-17 (helper)Imports the helper function get_plane_client_context used by list_modules.
from plane_mcp.client import get_plane_client_context