list_work_logs

Instructions

Implementation Reference

• plane_mcp/tools/work_logs.py:15-37 (handler)

  The handler function for the 'list_work_logs' tool. It accepts project_id, work_item_id, and optional params, gets the Plane client context, and calls client.work_items.work_logs.list() to fetch work logs.

  def list_work_logs(
      project_id: str,
      work_item_id: str,
      params: dict[str, Any] | None = None,
  ) -> list[WorkItemWorkLog]:
      """
      List work logs for a work item.
  
      Args:
          project_id: UUID of the project
          work_item_id: UUID of the work item
          params: Optional query parameters as a dictionary
  
      Returns:
          List of WorkItemWorkLog objects
      """
      client, workspace_slug = get_plane_client_context()
      return client.work_items.work_logs.list(
          workspace_slug=workspace_slug,
          project_id=project_id,
          work_item_id=work_item_id,
          params=params,
      )

• plane_mcp/tools/work_logs.py:15-19 (schema)

  Input schema: project_id (str), work_item_id (str), params (dict[str, Any] | None). Output type: list[WorkItemWorkLog].

  def list_work_logs(
      project_id: str,
      work_item_id: str,
      params: dict[str, Any] | None = None,
  ) -> list[WorkItemWorkLog]:

• plane_mcp/tools/work_logs.py:11-37 (registration)

  Registration: The function list_work_logs is registered as an MCP tool via the @mcp.tool() decorator in register_work_log_tools().

  def register_work_log_tools(mcp: FastMCP) -> None:
      """Register all work log-related tools with the MCP server."""
  
      @mcp.tool()
      def list_work_logs(
          project_id: str,
          work_item_id: str,
          params: dict[str, Any] | None = None,
      ) -> list[WorkItemWorkLog]:
          """
          List work logs for a work item.
  
          Args:
              project_id: UUID of the project
              work_item_id: UUID of the work item
              params: Optional query parameters as a dictionary
  
          Returns:
              List of WorkItemWorkLog objects
          """
          client, workspace_slug = get_plane_client_context()
          return client.work_items.work_logs.list(
              workspace_slug=workspace_slug,
              project_id=project_id,
              work_item_id=work_item_id,
              params=params,
          )

• plane_mcp/tools/__init__.py:23-35 (registration)

  Import of register_work_log_tools in the tools package __init__.py, and it's called at line 35 to register all work log tools.

  from plane_mcp.tools.work_logs import register_work_log_tools
  from plane_mcp.tools.workspaces import register_workspace_tools
  
  
  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)

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

  The get_plane_client_context() helper function that initializes and returns a PlaneClient instance with workspace slug, used by list_work_logs to get the client.

  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,
      )