Skip to main content
Glama
goto-software

plane-mcp-server

by goto-software
OverviewSchemaRelated ServersScoreDiscussions
Python
Hybrid

list_archived_modules

Retrieve all archived modules within a specified project to review past work or manage inactive tasks.

Instructions

List archived modules in a project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesUUID of the project
paramsNoOptional query parameters as a dictionary

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • plane_mcp/tools/modules.py:184-204 (handler)
    The tool handler function 'list_archived_modules' that calls client.modules.list_archived() and returns the results.
    @mcp.tool()
def list_archived_modules(
    project_id: str,
    params: dict[str, Any] | None = None,
) -> list[Module]:
    """
    List archived 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 archived Module objects
    """
    client, workspace_slug = get_plane_client_context()
    response: PaginatedArchivedModuleResponse = client.modules.list_archived(
        workspace_slug=workspace_slug, project_id=project_id, params=params
    )
    return response.results
  • plane_mcp/tools/modules.py:20-21 (registration)
    Registration entry point 'register_module_tools' that registers all module tools including list_archived_modules via the @mcp.tool() decorator.
    def register_module_tools(mcp: FastMCP) -> None:
    """Register all module-related tools with the MCP server."""
  • plane_mcp/tools/__init__.py:11-11 (registration)
    Import of register_module_tools in the tools package init.
    from plane_mcp.tools.modules import register_module_tools
  • plane_mcp/tools/__init__.py:38-38 (registration)
    Call to register_module_tools(mcp) which triggers registration of all module tools including list_archived_modules.
    register_module_tools(mcp)
  • plane_mcp/tools/modules.py:10-10 (schema)
    Import of PaginatedArchivedModuleResponse used as the response schema for list_archived_modules.
    PaginatedArchivedModuleResponse,

Tool Definition Quality

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description indicates a read operation ('list'), which is consistent with expectations. However, no annotations are present, and the description does not disclose details about the return format, pagination, or any rate limits. The output schema likely provides some structure, but the description adds no behavioral context beyond the verb.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, focused sentence with no redundant words. It is front-loaded with the action and resource, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (list operation) and the presence of an output schema, the description is adequate. It could be improved by noting that this returns archived modules specifically, complementing sibling tools. However, it does not miss critical information for an agent to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema description coverage is 100%, so the schema already documents the parameters. The description adds no additional meaning about the optional 'params' dictionary, such as accepted keys or default behavior. A higher score would require enriching the parameter details beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'List archived modules in a project' clearly specifies the action (list) and the resource (archived modules). It differentiates from sibling tools like 'list_modules' (which presumably lists non-archived modules) and 'archive_module'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the tool is for retrieving archived modules but does not explicitly state when to use it versus alternatives like 'list_modules'. No guidance on prerequisites or context is provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/goto-software/plane-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server