remove_work_item_from_cycle

Instructions

Implementation Reference

• plane_mcp/tools/cycles.py:212-233 (handler)

  The handler function for the 'remove_work_item_from_cycle' tool. Decorated with @mcp.tool(), it removes a work item from a cycle by calling the Plane client's cycles.remove_work_item method with workspace_slug, project_id, cycle_id, and work_item_id.

  @mcp.tool()
  def remove_work_item_from_cycle(
      project_id: str,
      cycle_id: str,
      work_item_id: str,
  ) -> None:
      """
      Remove a work item from a cycle.
  
      Args:
          workspace_slug: The workspace slug identifier
          project_id: UUID of the project
          cycle_id: UUID of the cycle
          work_item_id: UUID of the work item to remove
      """
      client, workspace_slug = get_plane_client_context()
      client.cycles.remove_work_item(
          workspace_slug=workspace_slug,
          project_id=project_id,
          cycle_id=cycle_id,
          work_item_id=work_item_id,
      )

• plane_mcp/tools/cycles.py:212-233 (registration)

  The tool is registered via the @mcp.tool() decorator inside the register_cycle_tools function, which is called from plane_mcp/tools/__init__.py's register_tools() function.

  @mcp.tool()
  def remove_work_item_from_cycle(
      project_id: str,
      cycle_id: str,
      work_item_id: str,
  ) -> None:
      """
      Remove a work item from a cycle.
  
      Args:
          workspace_slug: The workspace slug identifier
          project_id: UUID of the project
          cycle_id: UUID of the cycle
          work_item_id: UUID of the work item to remove
      """
      client, workspace_slug = get_plane_client_context()
      client.cycles.remove_work_item(
          workspace_slug=workspace_slug,
          project_id=project_id,
          cycle_id=cycle_id,
          work_item_id=work_item_id,
      )

• plane_mcp/tools/__init__.py:27-36 (registration)

  Top-level registration: register_cycle_tools(mcp) is called from register_tools(), which registers all cycle tools including remove_work_item_from_cycle.

  def register_tools(mcp: FastMCP) -> None:
      """Register all tools with the MCP server."""
      register_project_tools(mcp)
      register_work_item_tools(mcp)
      register_work_item_activity_tools(mcp)
      register_work_item_comment_tools(mcp)
      register_work_item_link_tools(mcp)
      register_work_item_relation_tools(mcp)
      register_work_log_tools(mcp)
      register_cycle_tools(mcp)

• plane_mcp/client.py:21-74 (helper)

  Helper function get_plane_client_context() that provides the Plane client instance and workspace_slug used by the handler to make the API call.

  def get_plane_client_context() -> PlaneClientContext:
      """
      Initialize and return a PlaneClient instance with workspace context.
  
      Authentication is handled by the PlaneOAuthProvider, which supports:
      1. Environment variables (PLANE_API_KEY + PLANE_WORKSPACE_SLUG)
      2. HTTP headers (x-api-key + x-workspace-slug)
      3. OAuth access token
  
      Environment variables:
      - PLANE_INTERNAL_BASE_URL: Internal URL for Plane API (preferred for server-to-server calls)
      - PLANE_BASE_URL: Base URL for Plane API (fallback, default: https://api.plane.so)
  
      Returns:
          PlaneClientContext containing configured PlaneClient instance and workspace slug
  
      Raises:
          ConfigurationError: If access token is not available or workspace slug is missing
      """
      base_url = os.getenv("PLANE_INTERNAL_BASE_URL") or os.getenv("PLANE_BASE_URL", "https://api.plane.so")
      workspace_slug = os.getenv("PLANE_WORKSPACE_SLUG", "")
  
      api_key = os.getenv("PLANE_API_KEY", "")
      access_token = None
  
      # Get access token from the OAuth provider (which handles all auth methods)
      stored_access_token: AccessToken | None = get_access_token()
      if stored_access_token:
          # Determine authentication method to use appropriate PlaneClient constructor
          auth_method = stored_access_token.claims.get("auth_method", "oauth")
          token = stored_access_token.token
          workspace_slug = stored_access_token.claims.get("workspace_slug", "")
  
          # For API key auth methods, use api_key parameter; for OAuth, use access_token
          if auth_method in ("api_key_env", "api_key_header"):
              api_key = token
          else:
              access_token = token
  
      if access_token:
          client = PlaneClient(
              base_url=base_url,
              access_token=access_token,
          )
      else:
          client = PlaneClient(
              base_url=base_url,
              api_key=api_key,
          )
  
      return PlaneClientContext(
          client=client,
          workspace_slug=workspace_slug,
      )