Skip to main content
Glama
goto-software

plane-mcp-server

archive_module

Archive a specific module in a project by providing its project and module IDs.

Instructions

Archive a module.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesUUID of the project
module_idYesUUID of the module

Implementation Reference

  • The handler function for the 'archive_module' tool. It retrieves the Plane client context and calls client.modules.archive() to archive the specified module.
    @mcp.tool()
    def archive_module(project_id: str, module_id: str) -> None:
        """
        Archive a module.
    
        Args:
            workspace_slug: The workspace slug identifier
            project_id: UUID of the project
            module_id: UUID of the module
        """
        client, workspace_slug = get_plane_client_context()
        client.modules.archive(workspace_slug=workspace_slug, project_id=project_id, module_id=module_id)
  • The registration function for all module tools, including archive_module. The @mcp.tool() decorator on line 279 registers it.
    def register_module_tools(mcp: FastMCP) -> None:
        """Register all module-related tools with the MCP server."""
  • The top-level registration call that triggers module tool registration.
    register_module_tools(mcp)
  • Import of register_module_tools into the tools package init.
    from plane_mcp.tools.modules import register_module_tools
  • Helper utility that provides the PlaneClient and workspace_slug used by the archive_module handler.
    def get_plane_client_context() -> PlaneClientContext:
        """
Behavior2/5

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

No annotations and no description of effects: what archiving does, reversibility, or side effects.

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

Conciseness4/5

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

Single short sentence, front-loaded, but could include more details without losing conciseness.

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

Completeness2/5

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

Given no output schema and no annotations, the description fails to explain the tool's behavior fully.

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?

Schema covers both parameters with descriptions; description adds no extra meaning.

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

Purpose4/5

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

Clear verb+resource combination 'Archive a module' but lacks differentiation from siblings like 'unarchive_module' or 'delete_module'.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives such as unarchive or delete.

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