openhands-tools 1.10.0__py3-none-any.whl → 1.11.1__py3-none-any.whl

openhands/tools/planning_file_editor/definition.py

@@ -8,6 +8,7 @@ from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from openhands.sdk.conversation.state import ConversationState
 
+from openhands.sdk.logger import get_logger
 from openhands.sdk.tool import (
     ToolAnnotations,
     ToolDefinition,
@@ -20,7 +21,12 @@ from openhands.tools.file_editor.definition import (
 )
 
 
-# Hardcoded plan filename
+logger = get_logger(__name__)
+
+# Default config directory and plan filename
+# PLAN.md is now stored in .agents_tmp/ to keep workspace root clean
+# and separate agent temporary files from user content
+DEFAULT_CONFIG_DIR = ".agents_tmp"
 PLAN_FILENAME = "PLAN.md"
 
 
@@ -62,11 +68,17 @@ class PlanningFileEditorTool(
     def create(
         cls,
         conv_state: "ConversationState",
+        plan_path: str | None = None,
     ) -> Sequence["PlanningFileEditorTool"]:
         """Initialize PlanningFileEditorTool.
 
         Args:
             conv_state: Conversation state to get working directory from.
+            plan_path: Optional absolute path to PLAN.md file. If not provided,
+                defaults to {working_dir}/.agents_tmp/PLAN.md.
+
+        Raises:
+            ValueError: If plan_path is provided but is not an absolute path.
         """
         # Import here to avoid circular imports
         from openhands.tools.planning_file_editor.impl import (
@@ -74,8 +86,31 @@ class PlanningFileEditorTool(
         )
 
         working_dir = conv_state.workspace.working_dir
-        workspace_root = Path(working_dir).resolve()
-        plan_path = str(workspace_root / PLAN_FILENAME)
+
+        # Validate plan_path is absolute if provided
+        if plan_path is not None and not Path(plan_path).is_absolute():
+            raise ValueError(f"plan_path must be an absolute path, got: {plan_path}")
+
+        # Use provided plan_path or fall back to .agents_tmp/PLAN.md at workspace root
+        if plan_path is None:
+            workspace_root = Path(working_dir).resolve()
+
+            # Check for legacy PLAN.md at workspace root
+            legacy_plan_path = workspace_root / PLAN_FILENAME
+            if legacy_plan_path.exists():
+                # Use legacy location for backward compatibility
+                new_recommended_path = (
+                    workspace_root / DEFAULT_CONFIG_DIR / PLAN_FILENAME
+                )
+                logger.warning(
+                    f"Found PLAN.md at legacy location {legacy_plan_path}. "
+                    f"Consider moving it to {new_recommended_path} "
+                    f"for consistency with OpenHands conventions."
+                )
+                plan_path = str(legacy_plan_path)
+            else:
+                # Use new default location
+                plan_path = str(workspace_root / DEFAULT_CONFIG_DIR / PLAN_FILENAME)
 
         # Initialize PLAN.md with headers if it doesn't exist
         plan_file = Path(plan_path)
@@ -83,7 +118,10 @@ class PlanningFileEditorTool(
             # Import here to avoid circular imports
             from openhands.tools.preset.planning import get_plan_headers
 
+            # Ensure parent directory exists
+            plan_file.parent.mkdir(parents=True, exist_ok=True)
             plan_file.write_text(get_plan_headers())
+            logger.info(f"Created new PLAN.md at {plan_path}")
 
         # Create executor with restricted edit access to PLAN.md only
         executor = PlanningFileEditorExecutor(

openhands/tools/preset/planning.py

@@ -102,9 +102,13 @@ def register_planning_tools() -> None:
     logger.debug("Tool: PlanningFileEditorTool registered.")
 
 
-def get_planning_tools() -> list[Tool]:
+def get_planning_tools(plan_path: str | None = None) -> list[Tool]:
     """Get the planning agent tool specifications.
 
+    Args:
+        plan_path: Optional absolute path to PLAN.md file. If provided, will be
+            passed to PlanningFileEditorTool via params.
+
     Returns:
         List of tools optimized for planning and analysis tasks, including
         file viewing and PLAN.md editing capabilities for advanced
@@ -117,10 +121,15 @@ def get_planning_tools() -> list[Tool]:
     from openhands.tools.grep import GrepTool
     from openhands.tools.planning_file_editor import PlanningFileEditorTool
 
+    # Build params for PlanningFileEditorTool if plan_path is provided
+    planning_tool_params = {}
+    if plan_path:
+        planning_tool_params["plan_path"] = plan_path
+
     return [
         Tool(name=GlobTool.name),
         Tool(name=GrepTool.name),
-        Tool(name=PlanningFileEditorTool.name),
+        Tool(name=PlanningFileEditorTool.name, params=planning_tool_params),
     ]
 
 

openhands/tools/terminal/terminal/terminal_session.py

@@ -5,8 +5,10 @@ import time
 from enum import Enum
 
 from openhands.sdk.logger import get_logger
+from openhands.sdk.utils import maybe_truncate
 from openhands.tools.terminal.constants import (
     CMD_OUTPUT_PS1_END,
+    MAX_CMD_OUTPUT_SIZE,
     NO_CHANGE_TIMEOUT_SECONDS,
     POLL_INTERVAL,
     TIMEOUT_MESSAGE_TEMPLATE,
@@ -183,6 +185,10 @@ class TerminalSession(TerminalSessionBase):
             raw_command_output,
             metadata,
         )
+        command_output = maybe_truncate(
+            command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+        )
+
         self.prev_status = TerminalCommandStatus.COMPLETED
         self.prev_output = ""  # Reset previous command output
         self._ready_for_next_command()
@@ -221,6 +227,9 @@ class TerminalSession(TerminalSessionBase):
             metadata,
             continue_prefix="[Below is the output of the previous command.]\n",
         )
+        command_output = maybe_truncate(
+            command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+        )
         return TerminalObservation.from_text(
             command=command,
             text=command_output,
@@ -257,6 +266,9 @@ class TerminalSession(TerminalSessionBase):
             metadata,
             continue_prefix="[Below is the output of the previous command.]\n",
         )
+        command_output = maybe_truncate(
+            command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+        )
         return TerminalObservation.from_text(
             command=command,
             exit_code=metadata.exit_code,
@@ -391,6 +403,9 @@ class TerminalSession(TerminalSessionBase):
                 metadata,
                 continue_prefix="[Below is the output of the previous command.]\n",
             )
+            command_output = maybe_truncate(
+                command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+            )
             obs = TerminalObservation.from_text(
                 command=command,
                 text=command_output,

openhands/tools/terminal/utils/command.py

@@ -141,7 +141,7 @@ def escape_bash_special_chars(command: str) -> str:
         remaining = command[last_pos:]
         parts.append(remaining)
         return "".join(parts)
-    except (ParsingError, NotImplementedError, TypeError):
+    except (ParsingError, NotImplementedError, TypeError, AttributeError):
         logger.debug(
             f"Failed to parse bash commands for special characters escape\n[input]: "
             f"{command}\n[warning]: {traceback.format_exc()}\nThe original command "

{openhands_tools-1.10.0.dist-info → openhands_tools-1.11.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openhands-tools
-Version: 1.10.0
+Version: 1.11.1
 Summary: OpenHands Tools - Runtime tools for AI agents
 Project-URL: Source, https://github.com/OpenHands/software-agent-sdk
 Project-URL: Homepage, https://github.com/OpenHands/software-agent-sdk

{openhands_tools-1.10.0.dist-info → openhands_tools-1.11.1.dist-info}/RECORD

@@ -48,13 +48,13 @@ openhands/tools/grep/__init__.py,sha256=XJscA-rP35sCCpILkcCF36sd_RG8XdTx6X3N12W7
 openhands/tools/grep/definition.py,sha256=Nok-GtLv39a93y6s6BnJdL6nRERpPvk9LVX30lg6yHA,3970
 openhands/tools/grep/impl.py,sha256=mCib7eZi_nKCOBFMWv5-d1jSz3N7VpGOVnAs3KDf3PY,8647
 openhands/tools/planning_file_editor/__init__.py,sha256=edIuvR5ZnEXXsYfRt8xbrq15Z6vtdUq4AMguuuk1grI,197
-openhands/tools/planning_file_editor/definition.py,sha256=7wzE1qXoengRq80MjDI-XbWhbPVYLU1lThFO9Mq14wg,3927
+openhands/tools/planning_file_editor/definition.py,sha256=1llmMozk0STSgIc-9GKc02MfEDb7YC0oLaRMCRG0Xko,5723
 openhands/tools/planning_file_editor/impl.py,sha256=W8Mdy7Qjbz90iKSmisw23-TcFtXwe7Vk373WvrScCS8,2218
 openhands/tools/preset/__init__.py,sha256=KougtVUTSj9D6AjR78EXmYRdITY6ZIaodCQuWfViXc0,913
 openhands/tools/preset/default.py,sha256=r6lAqHD-4ntjiOSfNvSxuAJtJqqTTik_mBIFZOE1w7Q,2686
 openhands/tools/preset/gemini.py,sha256=FG3BcJjnm6tDLIjg6EiDFTksx5lVVBInh_Jpza0mHpU,3136
 openhands/tools/preset/gpt5.py,sha256=44LOv6MncP9X9QU7pn1UfdjYl8ec8zKU9jUU7tUYR5I,2615
-openhands/tools/preset/planning.py,sha256=s05upBJ97JEZOfUJMkBW3xa5ZKgxZFklY1yHEBzqmhQ,5303
+openhands/tools/preset/planning.py,sha256=SOe2A5Nr-jkgQAouCKGCyo3UfRKaUB8xbAFA59m69xA,5682
 openhands/tools/task_tracker/__init__.py,sha256=NVm3CE_CkIAUSjFexh7HLXMpibJ_Dh8J8OOow2SlE1I,302
 openhands/tools/task_tracker/definition.py,sha256=yGN_wks_-QpjRlfYiv5uOYyRTshaFuBwog0P62m5x0w,15772
 openhands/tools/terminal/__init__.py,sha256=L5iQMMVhQbB_p2DESxGKo67D9kvjU0XIVR8LBuQ7HiY,657
@@ -66,15 +66,15 @@ openhands/tools/terminal/terminal/__init__.py,sha256=UL08nepNd-k4jWBglQAKtg4aPjg
 openhands/tools/terminal/terminal/factory.py,sha256=Q9w-6AV-2aRpcTrKotdDDEKq1_7zc7I0MFb3sxXU374,4475
 openhands/tools/terminal/terminal/interface.py,sha256=g0nyhMzVsIGptfBnBdv6FESUtv7k-EnRI32KYYl2VO0,6854
 openhands/tools/terminal/terminal/subprocess_terminal.py,sha256=vKvcX_0H7ck3_BHWbir41NTI6srH4hCymOt48doq8js,16269
-openhands/tools/terminal/terminal/terminal_session.py,sha256=Y3n95JQfG_nid4g_j2873uVPjl-UQwiu3H3vwkijbrM,20159
+openhands/tools/terminal/terminal/terminal_session.py,sha256=Mast2NgG5gW7Yefl61AFUf_HAMYaShZMQ_AQCUowuS4,20700
 openhands/tools/terminal/terminal/tmux_terminal.py,sha256=QMXeTs45WWeM6VzbHN3eCAYu9xXsHpFa6prsfNkOG3M,6187
-openhands/tools/terminal/utils/command.py,sha256=ZT6KMFQNIpMMWGKnG8HAlCJpaB34JcbYYfYBjcLNTQs,5434
+openhands/tools/terminal/utils/command.py,sha256=RWmBsiXvEuDNQP4s52FvbWcTbm_vxdXYvI2aZHu0H_E,5450
 openhands/tools/tom_consult/__init__.py,sha256=av9VYJRWHmP4_5Eu2840PARtgOTRP84jZjqJ3zs8sRs,581
 openhands/tools/tom_consult/definition.py,sha256=MTdOCOJaEGgOXhlJ9-x0HdhD6JiKNT2DodEOdsB4RBg,8224
 openhands/tools/tom_consult/executor.py,sha256=LkWeltj-7ZgLhVZKZP4cuhxqg2YuyRnqSz5S0U9WElk,16656
 openhands/tools/utils/__init__.py,sha256=AgJX59QLQTulZqIvJnUqM7LxAgsFhtqmgol-lKLc7Wc,1253
 openhands/tools/utils/timeout.py,sha256=AjKNLZa8NqQ0HllZzqWZwZMj-8PEWHHBXwOlMjTygpA,399
-openhands_tools-1.10.0.dist-info/METADATA,sha256=7aBR3o2KlLBYrZxhtmkHxFhId6OPFw9fyUC6_5YJlKA,699
-openhands_tools-1.10.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-openhands_tools-1.10.0.dist-info/top_level.txt,sha256=jHgVu9I0Blam8BXFgedoGKfglPF8XvW1TsJFIjcgP4E,10
-openhands_tools-1.10.0.dist-info/RECORD,,
+openhands_tools-1.11.1.dist-info/METADATA,sha256=QPPoOi1v8U7qcTc2JPjH9_mH4c8ExxCdxs_PfuE6_Dg,699
+openhands_tools-1.11.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+openhands_tools-1.11.1.dist-info/top_level.txt,sha256=jHgVu9I0Blam8BXFgedoGKfglPF8XvW1TsJFIjcgP4E,10
+openhands_tools-1.11.1.dist-info/RECORD,,