openhands-agent-server 1.22.0__tar.gz → 1.23.0__tar.gz

{openhands_agent_server-1.22.0 → openhands_agent_server-1.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openhands-agent-server
-Version: 1.22.0
+Version: 1.23.0
 Summary: OpenHands Agent Server - REST/WebSocket interface for OpenHands AI Agent
 Project-URL: Source, https://github.com/OpenHands/software-agent-sdk
 Project-URL: Homepage, https://github.com/OpenHands/software-agent-sdk

{openhands_agent_server-1.22.0 → openhands_agent_server-1.23.0}/openhands/agent_server/__main__.py

@@ -18,6 +18,7 @@ logger = get_logger(__name__)
 
 
 _INTERNAL_SERVER_URL_ENV = "OH_INTERNAL_SERVER_URL"
+_EXTRA_PYTHON_PATH_ENV = "OH_EXTRA_PYTHON_PATH"
 
 
 def _get_internal_server_url(host: str, port: int) -> str:
@@ -43,6 +44,46 @@ def _get_internal_server_url(host: str, port: int) -> str:
     return f"http://{resolved_host}:{port}"
 
 
+def extend_python_path(extra_paths: str | None) -> None:
+    """Add directories to ``sys.path`` so ``importlib.import_module`` can find
+    external custom-tool modules — even when running from a PyInstaller binary.
+
+    Paths are read from *extra_paths* (``--extra-python-path`` CLI arg) **and**
+    the ``OH_EXTRA_PYTHON_PATH`` environment variable.  Both use the
+    platform path separator (``':'`` on POSIX, ``';'`` on Windows).
+
+    Non-existent directories are skipped with a warning; duplicates and paths
+    already on ``sys.path`` are silently ignored.
+    """
+    raw_parts: list[str] = []
+    for source in (extra_paths, os.environ.get(_EXTRA_PYTHON_PATH_ENV)):
+        if source:
+            raw_parts.extend(source.split(os.pathsep))
+
+    added = 0
+    for part in raw_parts:
+        part = part.strip()
+        if not part:
+            continue
+        resolved = os.path.abspath(part)
+        if not os.path.isdir(resolved):
+            logger.warning(
+                "Ignoring non-existent --extra-python-path entry: %s", resolved
+            )
+            continue
+        if resolved not in sys.path:
+            sys.path.insert(0, resolved)
+            logger.info("Added to sys.path: %s", resolved)
+            added += 1
+
+    if added:
+        logger.info(
+            "Extended sys.path with %d director%s for custom tool imports",
+            added,
+            "y" if added == 1 else "ies",
+        )
+
+
 def preload_modules(modules_arg: str | None) -> None:
     """Import user-specified modules so their top-level side effects run.
 
@@ -171,6 +212,16 @@ def main() -> None:
             "(e.g. 'myapp.tools,myapp.plugins')"
         ),
     )
+    parser.add_argument(
+        "--extra-python-path",
+        type=str,
+        default=None,
+        help=(
+            "Additional directories to add to sys.path for custom tool imports "
+            f"('{os.pathsep}'-separated).  Also reads from the "
+            f"{_EXTRA_PYTHON_PATH_ENV} environment variable."
+        ),
+    )
 
     args = parser.parse_args()
 
@@ -181,6 +232,10 @@ def main() -> None:
         else:
             sys.exit(1)
 
+    # Extend sys.path before importing user modules so external .py files
+    # are reachable — critical for PyInstaller binary builds.
+    extend_python_path(args.extra_python_path)
+
     # Import user modules after early-exit checks
     preload_modules(args.import_modules)
 

{openhands_agent_server-1.22.0 → openhands_agent_server-1.23.0}/openhands/agent_server/api.py

@@ -38,6 +38,7 @@ from openhands.agent_server.file_router import file_router
 from openhands.agent_server.git_router import git_router
 from openhands.agent_server.hooks_router import hooks_router
 from openhands.agent_server.llm_router import llm_router
+from openhands.agent_server.mcp_router import mcp_router
 from openhands.agent_server.middleware import LocalhostCORSMiddleware
 from openhands.agent_server.profiles_router import profiles_router
 from openhands.agent_server.server_details_router import (
@@ -53,6 +54,7 @@ from openhands.agent_server.tool_router import tool_router
 from openhands.agent_server.vscode_router import vscode_router
 from openhands.agent_server.vscode_service import get_vscode_service
 from openhands.agent_server.workspace_router import workspace_router
+from openhands.agent_server.workspaces_router import workspaces_router
 from openhands.sdk.logger import DEBUG, get_logger
 from openhands.sdk.utils.redact import sanitize_dict
 from openhands.tools.terminal.constants import TMUX_SOCKET_NAME
@@ -288,7 +290,9 @@ def _add_api_routes(app: FastAPI, config: Config) -> None:
     api_router.include_router(skills_router)
     api_router.include_router(hooks_router)
     api_router.include_router(llm_router)
+    api_router.include_router(mcp_router)
     api_router.include_router(settings_router)
+    api_router.include_router(workspaces_router)
     api_router.include_router(profiles_router)
     api_router.include_router(cloud_proxy_router)
     # /api/auth/* mints workspace cookies and requires the header to bootstrap,

{openhands_agent_server-1.22.0 → openhands_agent_server-1.23.0}/openhands/agent_server/bash_service.py

@@ -32,7 +32,8 @@ class BashEventService:
 
     bash_events_dir: Path = field()
     _pub_sub: PubSub[BashEventBase] = field(
-        default_factory=lambda: PubSub[BashEventBase](), init=False
+        default_factory=lambda: PubSub[BashEventBase](max_subscribers=50),
+        init=False,
     )
 
     def _ensure_bash_events_dir(self) -> None:

{openhands_agent_server-1.22.0 → openhands_agent_server-1.23.0}/openhands/agent_server/config.py

@@ -174,6 +174,15 @@ class Config(BaseModel):
         default=True,
         description="Whether to preload tools",
     )
+    max_concurrent_runs: int = Field(
+        default=10,
+        ge=1,
+        description=(
+            "Maximum number of conversations that can execute agent steps "
+            "concurrently.  Controls the size of the dedicated thread pool "
+            "used for conversation.run() calls."
+        ),
+    )
     secret_key: SecretStr | None = Field(
         default_factory=_default_secret_key,
         description=(

{openhands_agent_server-1.22.0 → openhands_agent_server-1.23.0}/openhands/agent_server/conversation_router.py

@@ -19,12 +19,10 @@ from openhands.agent_server._secrets_exposure import (
     decrypt_incoming_llm_secrets,
     get_cipher,
 )
-from openhands.agent_server.conversation_service import (
-    ConversationContractMismatchError,
-    ConversationService,
-)
+from openhands.agent_server.conversation_service import ConversationService
 from openhands.agent_server.dependencies import get_conversation_service
 from openhands.agent_server.models import (
+    INCLUDE_SKILLS_PARAM_TITLE,
     AgentResponseResult,
     AskAgentRequest,
     AskAgentResponse,
@@ -39,6 +37,7 @@ from openhands.agent_server.models import (
     Success,
     UpdateConversationRequest,
     UpdateSecretsRequest,
+    trim_conversation_response_skills,
 )
 from openhands.sdk import LLM, Agent, TextContent
 from openhands.sdk.conversation.state import ConversationExecutionStatus
@@ -89,14 +88,28 @@ async def search_conversations(
         ConversationSortOrder,
         Query(title="Sort order for conversations"),
     ] = ConversationSortOrder.CREATED_AT_DESC,
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> ConversationPage:
     """Search / List conversations"""
     assert limit > 0
     assert limit <= 100
-    return await conversation_service.search_conversations(
+    page = await conversation_service.search_conversations(
         page_id, limit, status, sort_order
     )
+    if not include_skills:
+        # ``model_copy`` rather than in-place mutation so we never
+        # write back into whatever the upstream service handed us
+        # (matters for services that cache their return value,
+        # including the ``AsyncMock`` used in route tests).
+        page = page.model_copy(
+            update={
+                "items": [
+                    trim_conversation_response_skills(item) for item in page.items
+                ]
+            }
+        )
+    return page
 
 
 @conversation_router.get("/count")
@@ -117,12 +130,15 @@ async def count_conversations(
 )
 async def get_conversation(
     conversation_id: UUID,
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> ConversationInfo:
     """Given an id, get a conversation"""
     conversation = await conversation_service.get_conversation(conversation_id)
     if conversation is None:
         raise HTTPException(status.HTTP_404_NOT_FOUND)
+    if not include_skills:
+        conversation = trim_conversation_response_skills(conversation)
     return conversation
 
 
@@ -150,38 +166,38 @@ async def get_conversation_agent_final_response(
 @conversation_router.get("")
 async def batch_get_conversations(
     ids: Annotated[list[UUID], Query()],
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> list[ConversationInfo | None]:
     """Get a batch of conversations given their ids, returning null for
     any missing item"""
     assert len(ids) < 100
     conversations = await conversation_service.batch_get_conversations(ids)
+    if not include_skills:
+        return [
+            trim_conversation_response_skills(c) if c is not None else None
+            for c in conversations
+        ]
     return conversations
 
 
 # Write Methods
 
 
-@conversation_router.post(
-    "",
-    responses={409: {"description": "Conversation contract mismatch"}},
-)
+@conversation_router.post("")
 async def start_conversation(
     request: Annotated[
         StartConversationRequest, Body(examples=START_CONVERSATION_EXAMPLES)
     ],
     response: Response,
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> ConversationInfo:
     """Start a conversation in the local environment."""
-    try:
-        info, is_new = await conversation_service.start_conversation(request)
-    except ConversationContractMismatchError as e:
-        raise HTTPException(
-            status_code=status.HTTP_409_CONFLICT,
-            detail=str(e),
-        ) from e
+    info, is_new = await conversation_service.start_conversation(request)
     response.status_code = status.HTTP_201_CREATED if is_new else status.HTTP_200_OK
+    if not include_skills:
+        info = trim_conversation_response_skills(info)
     return info
 
 
@@ -199,6 +215,26 @@ async def pause_conversation(
     return Success()
 
 
+@conversation_router.post(
+    "/{conversation_id}/interrupt",
+    responses={404: {"description": "Item not found"}},
+)
+async def interrupt_conversation(
+    conversation_id: UUID,
+    conversation_service: ConversationService = Depends(get_conversation_service),
+) -> Success:
+    """Immediately interrupt a running conversation.
+
+    Unlike ``/pause``, which waits for the current LLM call to finish,
+    ``/interrupt`` cancels the in-flight request so the effect is instant.
+    The conversation transitions to *paused* and can be resumed later.
+    """
+    interrupted = await conversation_service.interrupt_conversation(conversation_id)
+    if not interrupted:
+        raise HTTPException(status.HTTP_400_BAD_REQUEST)
+    return Success()
+
+
 @conversation_router.delete(
     "/{conversation_id}", responses={404: {"description": "Item not found"}}
 )
@@ -419,6 +455,7 @@ async def condense_conversation(
 async def fork_conversation(
     conversation_id: UUID,
     request: Annotated[ForkConversationRequest, Body()] = ForkConversationRequest(),  # noqa: B008
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> ConversationInfo:
     """Fork a conversation, deep-copying its event history.
@@ -444,4 +481,6 @@ async def fork_conversation(
             status.HTTP_404_NOT_FOUND,
             detail="Source conversation not found",
         )
+    if not include_skills:
+        info = trim_conversation_response_skills(info)
     return info

{openhands_agent_server-1.22.0 → openhands_agent_server-1.23.0}/openhands/agent_server/conversation_router_acp.py

@@ -1,5 +1,10 @@
 """ACP-capable conversation routes for the schema-sensitive endpoints."""
 
+# Deprecated REST contract: all /api/acp/conversations routes were deprecated
+# in v1.22.0 and are scheduled for removal in v1.27.0. The standard
+# FastAPI/OpenAPI deprecation marker for routes is ``deprecated=True`` on each
+# route decorator; keep matching docstring notices for CI deprecation checks.
+
 from typing import Annotated
 from uuid import UUID
 
@@ -9,11 +14,13 @@ from pydantic import SecretStr
 from openhands.agent_server.conversation_service import ConversationService
 from openhands.agent_server.dependencies import get_conversation_service
 from openhands.agent_server.models import (
+    INCLUDE_SKILLS_PARAM_TITLE,
     ACPConversationInfo,
     ACPConversationPage,
     ConversationSortOrder,
     SendMessageRequest,
     StartACPConversationRequest,
+    trim_conversation_response_skills,
 )
 from openhands.sdk import LLM, Agent, TextContent
 from openhands.sdk.agent.acp_agent import ACPAgent
@@ -53,7 +60,7 @@ START_ACP_CONVERSATION_EXAMPLES = [
 ]
 
 
-@conversation_router_acp.get("/search")
+@conversation_router_acp.get("/search", deprecated=True)
 async def search_acp_conversations(
     page_id: Annotated[
         str | None,
@@ -71,17 +78,31 @@ async def search_acp_conversations(
         ConversationSortOrder,
         Query(title="Sort order for conversations"),
     ] = ConversationSortOrder.CREATED_AT_DESC,
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> ACPConversationPage:
-    """Search conversations using the ACP-capable contract."""
+    """Search conversations using the ACP-capable contract.
+
+    Deprecated since v1.22.0 and scheduled for removal in v1.27.0.
+    Use ``/api/conversations/search`` instead.
+    """
     assert limit > 0
     assert limit <= 100
-    return await conversation_service.search_acp_conversations(
+    page = await conversation_service.search_acp_conversations(
         page_id, limit, status, sort_order
     )
-
-
-@conversation_router_acp.get("/count")
+    if not include_skills:
+        page = page.model_copy(
+            update={
+                "items": [
+                    trim_conversation_response_skills(item) for item in page.items
+                ]
+            }
+        )
+    return page
+
+
+@conversation_router_acp.get("/count", deprecated=True)
 async def count_acp_conversations(
     status: Annotated[
         ConversationExecutionStatus | None,
@@ -89,45 +110,76 @@ async def count_acp_conversations(
     ] = None,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> int:
-    """Count conversations using the ACP-capable contract."""
-    return await conversation_service.count_acp_conversations(status)
+    """Count conversations using the ACP-capable contract.
+
+    Deprecated since v1.22.0 and scheduled for removal in v1.27.0.
+    Use ``/api/conversations/count`` instead.
+    """
+    return await conversation_service.count_conversations(status)
 
 
 @conversation_router_acp.get(
     "/{conversation_id}",
     responses={404: {"description": "Item not found"}},
+    deprecated=True,
 )
 async def get_acp_conversation(
     conversation_id: UUID,
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> ACPConversationInfo:
-    """Get a conversation using the ACP-capable contract."""
+    """Get a conversation using the ACP-capable contract.
+
+    Deprecated since v1.22.0 and scheduled for removal in v1.27.0.
+    Use ``/api/conversations/{conversation_id}`` instead.
+    """
     conversation = await conversation_service.get_acp_conversation(conversation_id)
     if conversation is None:
         raise HTTPException(status.HTTP_404_NOT_FOUND)
+    if not include_skills:
+        conversation = trim_conversation_response_skills(conversation)
     return conversation
 
 
-@conversation_router_acp.get("")
+@conversation_router_acp.get("", deprecated=True)
 async def batch_get_acp_conversations(
     ids: Annotated[list[UUID], Query()],
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> list[ACPConversationInfo | None]:
-    """Batch get conversations using the ACP-capable contract."""
+    """Batch get conversations using the ACP-capable contract.
+
+    Deprecated since v1.22.0 and scheduled for removal in v1.27.0.
+    Use ``/api/conversations`` instead.
+    """
     assert len(ids) < 100
-    return await conversation_service.batch_get_acp_conversations(ids)
+    conversations = await conversation_service.batch_get_acp_conversations(ids)
+    if not include_skills:
+        return [
+            trim_conversation_response_skills(c) if c is not None else None
+            for c in conversations
+        ]
+    return conversations
 
 
-@conversation_router_acp.post("")
+@conversation_router_acp.post("", deprecated=True)
 async def start_acp_conversation(
     request: Annotated[
         StartACPConversationRequest,
         Body(examples=START_ACP_CONVERSATION_EXAMPLES),
     ],
     response: Response,
+    include_skills: Annotated[bool, Query(title=INCLUDE_SKILLS_PARAM_TITLE)] = False,
     conversation_service: ConversationService = Depends(get_conversation_service),
 ) -> ACPConversationInfo:
-    """Start a conversation using the ACP-capable contract."""
+    """Start a conversation using the ACP-capable contract.
+
+    Deprecated since v1.22.0 and scheduled for removal in v1.27.0.
+    Use ``/api/conversations`` instead; it now accepts ACP agents and
+    ``agent_settings`` payloads.
+    """
     info, is_new = await conversation_service.start_acp_conversation(request)
     response.status_code = status.HTTP_201_CREATED if is_new else status.HTTP_200_OK
+    if not include_skills:
+        info = trim_conversation_response_skills(info)
     return info