e2b-haystack 1.0.0__py3-none-any.whl

e2b_haystack-1.0.0.dist-info/METADATA

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: e2b-haystack
+Version: 1.0.0
+Summary: Haystack integration for E2B cloud sandboxes
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/e2b#readme
+Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
+Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/e2b
+Author-email: deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: E2B,Haystack,code execution,sandbox,tools
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: e2b>=2.0.0
+Requires-Dist: haystack-ai>=2.19.0
+Description-Content-Type: text/markdown
+
+# e2b-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/e2b-haystack.svg)](https://pypi.org/project/e2b-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/e2b-haystack.svg)](https://pypi.org/project/e2b-haystack)
+
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/e2b/CHANGELOG.md)
+
+---
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
+
+To run integration tests locally, set the `E2B_API_KEY` environment variable (get one at <https://e2b.dev/>).

e2b_haystack-1.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+haystack_integrations/tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/tools/e2b/__init__.py,sha256=XL_KIT6iXtKvwfoifJBVoGQZ9eEaWhwCwspgFpnGm3E,693
+haystack_integrations/tools/e2b/bash_tool.py,sha256=03GudyOqjBZHv1g47jYIgMdQjACVbL8PKeZ6LuGHMw4,3600
+haystack_integrations/tools/e2b/e2b_sandbox.py,sha256=J69pRUnMlgfzXSnoCmmqSMo2Px1oJ44NP4IbfAMlyWE,9232
+haystack_integrations/tools/e2b/list_directory_tool.py,sha256=5ZGdKcPUIxm5vfsIQv0cwT_GL1GjA-LB7SwK9Pg00Cc,2856
+haystack_integrations/tools/e2b/read_file_tool.py,sha256=FXG1F6oo3osL04nBHDhScEPvd1FQp4XEGyQVMXovVsw,2551
+haystack_integrations/tools/e2b/sandbox_toolset.py,sha256=iOxYmV7CajeOWYH308uBatmKd5JGMz56fw4tJb0uBVw,3532
+haystack_integrations/tools/e2b/write_file_tool.py,sha256=l-Cftsq9gxXZZgJvuaPx8m_-54Z6peD4lGtuTZc2g-4,2624
+e2b_haystack-1.0.0.dist-info/METADATA,sha256=G6GJUpMOoMoBeVJ7nYtduia3JsBUjD-LLgNPSfUzb_M,1868
+e2b_haystack-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+e2b_haystack-1.0.0.dist-info/licenses/LICENSE.txt,sha256=OrAtTu4aPmrTjKDSTzkSPgo_ji6NOMWO2N9JOTFyAzM,11350
+e2b_haystack-1.0.0.dist-info/RECORD,,

e2b_haystack-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

e2b_haystack-1.0.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023-present deepset GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

haystack_integrations/tools/e2b/__init__.py

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.tools.e2b.bash_tool import RunBashCommandTool
+from haystack_integrations.tools.e2b.e2b_sandbox import E2BSandbox
+from haystack_integrations.tools.e2b.list_directory_tool import ListDirectoryTool
+from haystack_integrations.tools.e2b.read_file_tool import ReadFileTool
+from haystack_integrations.tools.e2b.sandbox_toolset import E2BToolset
+from haystack_integrations.tools.e2b.write_file_tool import WriteFileTool
+
+__all__ = [
+    "E2BSandbox",
+    "E2BToolset",
+    "ListDirectoryTool",
+    "ReadFileTool",
+    "RunBashCommandTool",
+    "WriteFileTool",
+]

haystack_integrations/tools/e2b/bash_tool.py

@@ -0,0 +1,94 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.tools import Tool
+
+from haystack_integrations.tools.e2b.e2b_sandbox import E2BSandbox
+
+
+class RunBashCommandTool(Tool):
+    """
+    A :class:`~haystack.tools.Tool` that executes bash commands inside an E2B sandbox.
+
+    Pass the same :class:`E2BSandbox` instance to multiple tool classes so they
+    all operate in the same live sandbox environment.
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.tools.e2b import E2BSandbox, RunBashCommandTool, ReadFileTool
+
+    sandbox = E2BSandbox()
+    agent = Agent(
+        chat_generator=...,
+        tools=[
+            RunBashCommandTool(sandbox=sandbox),
+            ReadFileTool(sandbox=sandbox),
+        ],
+    )
+    ```
+    """
+
+    def __init__(self, sandbox: E2BSandbox) -> None:
+        """
+        Create a RunBashCommandTool.
+
+        :param sandbox: The :class:`E2BSandbox` instance that will execute commands.
+        """
+
+        def run_bash_command(command: str, timeout: int = 60) -> str:
+            sb = sandbox._require_sandbox()
+            try:
+                result = sb.commands.run(command, timeout=timeout)
+                return f"exit_code: {result.exit_code}\nstdout:\n{result.stdout}\nstderr:\n{result.stderr}"
+            except Exception as e:
+                # e2b raises CommandExitException for non-zero exit codes. That exception
+                # carries exit_code/stdout/stderr attributes — treat it as a valid result
+                # rather than an error so the LLM can see and react to the exit status.
+                if hasattr(e, "exit_code"):
+                    stdout = getattr(e, "stdout", "")
+                    stderr = getattr(e, "stderr", "")
+                    return f"exit_code: {e.exit_code}\nstdout:\n{stdout}\nstderr:\n{stderr}"  # type: ignore[union-attr]
+                msg = f"Failed to run bash command: {e}"
+                raise RuntimeError(msg) from e
+
+        super().__init__(
+            name="run_bash_command",
+            description=(
+                "Execute a bash command inside the E2B sandbox and return the combined stdout, "
+                "stderr, and exit code. Use this to run shell scripts, install packages, compile "
+                "code, or perform any system-level operation."
+            ),
+            parameters={
+                "type": "object",
+                "properties": {
+                    "command": {"type": "string", "description": "The bash command to execute."},
+                    "timeout": {
+                        "type": "integer",
+                        "description": (
+                            "Maximum number of seconds to wait for the command to finish. Defaults to 60 seconds."
+                        ),
+                    },
+                },
+                "required": ["command"],
+            },
+            function=run_bash_command,
+        )
+        self._e2b_sandbox = sandbox
+
+    def to_dict(self) -> dict[str, Any]:
+        """Serialize this tool to a dictionary."""
+        return {
+            "type": generate_qualified_class_name(type(self)),
+            "data": {"sandbox": self._e2b_sandbox.to_dict()},
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "RunBashCommandTool":
+        """Deserialize a RunBashCommandTool from a dictionary."""
+        sandbox = E2BSandbox.from_dict(data["data"]["sandbox"])
+        return cls(sandbox=sandbox)

haystack_integrations/tools/e2b/e2b_sandbox.py

@@ -0,0 +1,238 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import uuid
+import weakref
+from typing import Any, ClassVar
+
+from haystack import logging
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.lazy_imports import LazyImport
+from haystack.utils import Secret, deserialize_secrets_inplace
+
+with LazyImport(message="Run 'pip install e2b'") as e2b_import:
+    from e2b import Sandbox
+
+logger = logging.getLogger(__name__)
+
+
+class E2BSandbox:
+    """
+    Manages the lifecycle of an E2B cloud sandbox.
+
+    Instantiate this class and pass it to one or more E2B tool classes
+    (`RunBashCommandTool`, `ReadFileTool`, `WriteFileTool`,
+    `ListDirectoryTool`) to share a single sandbox environment across all
+    tools.  All tools that receive the same `E2BSandbox` instance operate
+    inside the same live sandbox process.
+
+    ### Usage example
+
+    ```python
+    from haystack.components.generators.chat import OpenAIChatGenerator
+    from haystack.components.agents import Agent
+
+    from haystack_integrations.tools.e2b import (
+        E2BSandbox,
+        RunBashCommandTool,
+        ReadFileTool,
+        WriteFileTool,
+        ListDirectoryTool,
+    )
+
+    sandbox = E2BSandbox()
+    agent = Agent(
+        chat_generator=OpenAIChatGenerator(model="gpt-4o"),
+        tools=[
+            RunBashCommandTool(sandbox=sandbox),
+            ReadFileTool(sandbox=sandbox),
+            WriteFileTool(sandbox=sandbox),
+            ListDirectoryTool(sandbox=sandbox),
+        ],
+    )
+    ```
+
+    Lifecycle is handled automatically by the Agent's pipeline. If you use the
+    tools standalone, call :meth:`warm_up` before the first tool invocation:
+
+    ```python
+    sandbox.warm_up()
+    # ... use tools ...
+    sandbox.close()
+    ```
+    """
+
+    # Process-wide cache used during deserialization to keep tools that
+    # shared one sandbox before serialization sharing it after `from_dict`
+    # as well. Keyed by `instance_id`. Weak refs so an entry disappears
+    # once no tool references the sandbox. A cache hit is only honored
+    # when the full serialized config matches (see `from_dict`), so a
+    # crafted YAML cannot hijack another tenant's live instance.
+    _instances: ClassVar["weakref.WeakValueDictionary[str, E2BSandbox]"] = weakref.WeakValueDictionary()
+
+    def __init__(
+        self,
+        api_key: Secret = Secret.from_env_var("E2B_API_KEY", strict=True),
+        sandbox_template: str = "base",
+        timeout: int = 120,
+        environment_vars: dict[str, str] | None = None,
+        instance_id: str | None = None,
+    ) -> None:
+        """
+        Create an E2BSandbox instance.
+
+        :param api_key: E2B API key.
+        :param sandbox_template: E2B sandbox template name.
+        :param timeout: Sandbox inactivity timeout in seconds.
+        :param environment_vars: Optional environment variables to inject into the sandbox.
+        :param instance_id: Stable identifier preserved across `to_dict`/`from_dict`. When
+            omitted, a fresh UUID is generated. Tools that share the same `E2BSandbox`
+            instance inherit this id, which is what lets them re-share the instance after
+            a serialization round-trip. Distinct from the cloud-side sandbox id assigned
+            by E2B at warm-up.
+        """
+        self.api_key = api_key
+        self.sandbox_template = sandbox_template
+        self.timeout = timeout
+        self.environment_vars = environment_vars or {}
+        self.instance_id = instance_id or uuid.uuid4().hex
+        self._sandbox: Any = None
+
+    # ------------------------------------------------------------------
+    # Lifecycle
+    # ------------------------------------------------------------------
+
+    def warm_up(self) -> None:
+        """
+        Establish the connection to the E2B sandbox.
+
+        Idempotent -- calling it multiple times has no effect if the sandbox is
+        already running.
+
+        :raises RuntimeError: If the E2B sandbox cannot be created.
+        """
+        if self._sandbox is not None:
+            return
+
+        e2b_import.check()
+        resolved_key = self.api_key.resolve_value()
+        try:
+            logger.info(
+                "Starting E2B sandbox (template={template}, timeout={timeout}s)",
+                template=self.sandbox_template,
+                timeout=self.timeout,
+            )
+            self._sandbox = Sandbox.create(
+                api_key=resolved_key,
+                template=self.sandbox_template,
+                timeout=self.timeout,
+                envs=self.environment_vars if self.environment_vars else None,
+            )
+            logger.info("E2B sandbox started (id={sandbox_id})", sandbox_id=self._sandbox.sandbox_id)
+        except Exception as e:
+            msg = f"Failed to start E2B sandbox: {e}"
+            raise RuntimeError(msg) from e
+
+    def close(self) -> None:
+        """
+        Shut down the E2B sandbox and release all associated resources.
+
+        Call this when you are done to avoid leaving idle sandboxes running.
+        """
+        if self._sandbox is None:
+            return
+        try:
+            self._sandbox.kill()
+            logger.info("E2B sandbox closed")
+        except Exception as e:
+            logger.warning("Failed to close E2B sandbox: {error}", error=e)
+        finally:
+            self._sandbox = None
+
+    # ------------------------------------------------------------------
+    # Serialisation
+    # ------------------------------------------------------------------
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize the sandbox configuration to a dictionary.
+
+        :returns: Dictionary containing the serialised configuration.
+        """
+        return {
+            "type": generate_qualified_class_name(type(self)),
+            "data": {
+                "instance_id": self.instance_id,
+                "api_key": self.api_key.to_dict(),
+                "sandbox_template": self.sandbox_template,
+                "timeout": self.timeout,
+                "environment_vars": self.environment_vars,
+            },
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "E2BSandbox":
+        """
+        Deserialize an :class:`E2BSandbox` from a dictionary.
+
+        Multiple tools that shared a single :class:`E2BSandbox` before serialization
+        will share the same restored instance: each tool's `from_dict` consults a
+        process-wide cache keyed on `instance_id`. A cache hit is only honored when
+        the full serialized config (api_key, template, timeout, environment_vars)
+        matches the cached entry — a crafted YAML with a guessed id but a different
+        config falls through to a fresh instance and never observes the cached one.
+
+        :param data: Dictionary created by :meth:`to_dict`.
+        :returns: An :class:`E2BSandbox` instance ready to be warmed up. May be a
+            previously-restored instance if the id and config match.
+        """
+        inner = data["data"]
+        instance_id = inner.get("instance_id")
+
+        # Snapshot the incoming config in its serialized (Secret-as-dict) form
+        # before `deserialize_secrets_inplace` mutates `inner`, so we can compare
+        # against `cached.api_key.to_dict()` symmetrically.
+        incoming_config = {
+            "api_key": inner.get("api_key"),
+            "sandbox_template": inner.get("sandbox_template", "base"),
+            "timeout": inner.get("timeout", 120),
+            "environment_vars": inner.get("environment_vars", {}),
+        }
+
+        if instance_id is not None:
+            cached = cls._instances.get(instance_id)
+            if cached is not None:
+                cached_config = {
+                    "api_key": cached.api_key.to_dict(),
+                    "sandbox_template": cached.sandbox_template,
+                    "timeout": cached.timeout,
+                    "environment_vars": cached.environment_vars,
+                }
+                if incoming_config == cached_config:
+                    return cached
+                # Id collision with mismatched config: fall through to building
+                # a fresh instance, but DO NOT register it — preserves the
+                # legitimate cached entry from being evicted.
+
+        deserialize_secrets_inplace(inner, keys=["api_key"])
+        instance = cls(
+            api_key=inner["api_key"],
+            sandbox_template=inner.get("sandbox_template", "base"),
+            timeout=inner.get("timeout", 120),
+            environment_vars=inner.get("environment_vars", {}),
+            instance_id=instance_id,
+        )
+        if instance_id is not None and instance_id not in cls._instances:
+            cls._instances[instance_id] = instance
+        return instance
+
+    # ------------------------------------------------------------------
+    # Internal helpers (used by the tool classes)
+    # ------------------------------------------------------------------
+
+    def _require_sandbox(self) -> "Sandbox":
+        """Return the active sandbox or raise a helpful error."""
+        if self._sandbox is None:
+            self.warm_up()
+        return self._sandbox

haystack_integrations/tools/e2b/list_directory_tool.py

@@ -0,0 +1,81 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.tools import Tool
+
+from haystack_integrations.tools.e2b.e2b_sandbox import E2BSandbox
+
+
+class ListDirectoryTool(Tool):
+    """
+    A :class:`~haystack.tools.Tool` that lists directory contents in an E2B sandbox.
+
+    Pass the same :class:`E2BSandbox` instance to multiple tool classes so they
+    all operate in the same live sandbox environment.
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.tools.e2b import E2BSandbox, ListDirectoryTool
+
+    sandbox = E2BSandbox()
+    agent = Agent(chat_generator=..., tools=[ListDirectoryTool(sandbox=sandbox)])
+    ```
+    """
+
+    def __init__(self, sandbox: E2BSandbox) -> None:
+        """
+        Create a ListDirectoryTool.
+
+        :param sandbox: The :class:`E2BSandbox` instance to list directories from.
+        """
+
+        def list_directory(path: str) -> str:
+            sb = sandbox._require_sandbox()
+            try:
+                entries = sb.files.list(path)
+                lines = []
+                for entry in entries:
+                    name = entry.name
+                    if getattr(entry, "is_dir", False) or getattr(entry, "type", "") == "dir":
+                        name = name + "/"
+                    lines.append(name)
+                return "\n".join(lines) if lines else "(empty directory)"
+            except Exception as e:
+                msg = f"Failed to list directory '{path}': {e}"
+                raise RuntimeError(msg) from e
+
+        super().__init__(
+            name="list_directory",
+            description=(
+                "List the files and subdirectories inside a directory in the E2B sandbox "
+                "filesystem. Returns a newline-separated list of names with a trailing '/' "
+                "appended to subdirectory names."
+            ),
+            parameters={
+                "type": "object",
+                "properties": {
+                    "path": {"type": "string", "description": "Absolute or relative path of the directory to list."}
+                },
+                "required": ["path"],
+            },
+            function=list_directory,
+        )
+        self._e2b_sandbox = sandbox
+
+    def to_dict(self) -> dict[str, Any]:
+        """Serialize this tool to a dictionary."""
+        return {
+            "type": generate_qualified_class_name(type(self)),
+            "data": {"sandbox": self._e2b_sandbox.to_dict()},
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "ListDirectoryTool":
+        """Deserialize a ListDirectoryTool from a dictionary."""
+        sandbox = E2BSandbox.from_dict(data["data"]["sandbox"])
+        return cls(sandbox=sandbox)

haystack_integrations/tools/e2b/read_file_tool.py

@@ -0,0 +1,76 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.tools import Tool
+
+from haystack_integrations.tools.e2b.e2b_sandbox import E2BSandbox
+
+
+class ReadFileTool(Tool):
+    """
+    A :class:`~haystack.tools.Tool` that reads files from an E2B sandbox filesystem.
+
+    Pass the same :class:`E2BSandbox` instance to multiple tool classes so they
+    all operate in the same live sandbox environment.
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.tools.e2b import E2BSandbox, ReadFileTool
+
+    sandbox = E2BSandbox()
+    agent = Agent(chat_generator=..., tools=[ReadFileTool(sandbox=sandbox)])
+    ```
+    """
+
+    def __init__(self, sandbox: E2BSandbox) -> None:
+        """
+        Create a ReadFileTool.
+
+        :param sandbox: The :class:`E2BSandbox` instance to read files from.
+        """
+
+        def read_file(path: str) -> str:
+            sb = sandbox._require_sandbox()
+            try:
+                content = sb.files.read(path)
+                if isinstance(content, bytes):
+                    return content.decode("utf-8", errors="replace")
+                return str(content)
+            except Exception as e:
+                msg = f"Failed to read file '{path}': {e}"
+                raise RuntimeError(msg) from e
+
+        super().__init__(
+            name="read_file",
+            description=(
+                "Read the text content of a file from the E2B sandbox filesystem and return it "
+                "as a string. The file must exist; use list_directory to verify paths first."
+            ),
+            parameters={
+                "type": "object",
+                "properties": {
+                    "path": {"type": "string", "description": "Absolute or relative path of the file to read."}
+                },
+                "required": ["path"],
+            },
+            function=read_file,
+        )
+        self._e2b_sandbox = sandbox
+
+    def to_dict(self) -> dict[str, Any]:
+        """Serialize this tool to a dictionary."""
+        return {
+            "type": generate_qualified_class_name(type(self)),
+            "data": {"sandbox": self._e2b_sandbox.to_dict()},
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "ReadFileTool":
+        """Deserialize a ReadFileTool from a dictionary."""
+        sandbox = E2BSandbox.from_dict(data["data"]["sandbox"])
+        return cls(sandbox=sandbox)

haystack_integrations/tools/e2b/sandbox_toolset.py

@@ -0,0 +1,97 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.tools import Toolset
+from haystack.utils import Secret, deserialize_secrets_inplace
+
+from haystack_integrations.tools.e2b.bash_tool import RunBashCommandTool
+from haystack_integrations.tools.e2b.e2b_sandbox import E2BSandbox
+from haystack_integrations.tools.e2b.list_directory_tool import ListDirectoryTool
+from haystack_integrations.tools.e2b.read_file_tool import ReadFileTool
+from haystack_integrations.tools.e2b.write_file_tool import WriteFileTool
+
+
+class E2BToolset(Toolset):
+    """
+    A :class:`~haystack.tools.Toolset` that bundles all E2B sandbox tools.
+
+    All tools in the set share a single :class:`E2BSandbox` instance so they
+    operate inside the same live sandbox process. The toolset owns the sandbox
+    lifecycle: calling :meth:`warm_up` starts the sandbox, and serialisation
+    round-trips preserve the shared-sandbox relationship.
+
+    ### Usage example
+
+    ```python
+    from haystack.components.generators.chat import OpenAIChatGenerator
+    from haystack.components.agents import Agent
+
+    from haystack_integrations.tools.e2b import E2BToolset
+
+    agent = Agent(
+        chat_generator=OpenAIChatGenerator(model="gpt-4o"),
+        tools=E2BToolset(),
+    )
+    ```
+    """
+
+    def __init__(
+        self,
+        api_key: Secret = Secret.from_env_var("E2B_API_KEY", strict=True),
+        sandbox_template: str = "base",
+        timeout: int = 120,
+        environment_vars: dict[str, str] | None = None,
+    ) -> None:
+        """
+        Create an E2BToolset.
+
+        :param api_key: E2B API key. Defaults to ``Secret.from_env_var("E2B_API_KEY")``.
+        :param sandbox_template: E2B sandbox template name. Defaults to ``"base"``.
+        :param timeout: Sandbox inactivity timeout in seconds. Defaults to ``120``.
+        :param environment_vars: Optional environment variables to inject into the sandbox.
+        """
+        self.sandbox = E2BSandbox(
+            api_key=api_key,
+            sandbox_template=sandbox_template,
+            timeout=timeout,
+            environment_vars=environment_vars,
+        )
+        super().__init__(
+            tools=[
+                RunBashCommandTool(sandbox=self.sandbox),
+                ReadFileTool(sandbox=self.sandbox),
+                WriteFileTool(sandbox=self.sandbox),
+                ListDirectoryTool(sandbox=self.sandbox),
+            ]
+        )
+
+    def warm_up(self) -> None:
+        """Start the shared E2B sandbox (idempotent)."""
+        self.sandbox.warm_up()
+
+    def close(self) -> None:
+        """Shut down the shared E2B sandbox and release cloud resources."""
+        self.sandbox.close()
+
+    def to_dict(self) -> dict[str, Any]:
+        """Serialize this toolset to a dictionary."""
+        return {
+            "type": generate_qualified_class_name(type(self)),
+            "data": self.sandbox.to_dict()["data"],
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "E2BToolset":
+        """Deserialize an E2BToolset from a dictionary."""
+        inner = data["data"]
+        deserialize_secrets_inplace(inner, keys=["api_key"])
+        return cls(
+            api_key=inner["api_key"],
+            sandbox_template=inner.get("sandbox_template", "base"),
+            timeout=inner.get("timeout", 120),
+            environment_vars=inner.get("environment_vars", {}),
+        )

haystack_integrations/tools/e2b/write_file_tool.py

@@ -0,0 +1,76 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.tools import Tool
+
+from haystack_integrations.tools.e2b.e2b_sandbox import E2BSandbox
+
+
+class WriteFileTool(Tool):
+    """
+    A :class:`~haystack.tools.Tool` that writes files to an E2B sandbox filesystem.
+
+    Pass the same :class:`E2BSandbox` instance to multiple tool classes so they
+    all operate in the same live sandbox environment.
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.tools.e2b import E2BSandbox, WriteFileTool
+
+    sandbox = E2BSandbox()
+    agent = Agent(chat_generator=..., tools=[WriteFileTool(sandbox=sandbox)])
+    ```
+    """
+
+    def __init__(self, sandbox: E2BSandbox) -> None:
+        """
+        Create a WriteFileTool.
+
+        :param sandbox: The :class:`E2BSandbox` instance to write files to.
+        """
+
+        def write_file(path: str, content: str) -> str:
+            sb = sandbox._require_sandbox()
+            try:
+                sb.files.write(path, content)
+                return f"File written successfully: {path}"
+            except Exception as e:
+                msg = f"Failed to write file '{path}': {e}"
+                raise RuntimeError(msg) from e
+
+        super().__init__(
+            name="write_file",
+            description=(
+                "Write text content to a file in the E2B sandbox filesystem. "
+                "Parent directories are created automatically if they do not exist. "
+                "Existing files are overwritten."
+            ),
+            parameters={
+                "type": "object",
+                "properties": {
+                    "path": {"type": "string", "description": "Absolute or relative path of the file to write."},
+                    "content": {"type": "string", "description": "Text content to write into the file."},
+                },
+                "required": ["path", "content"],
+            },
+            function=write_file,
+        )
+        self._e2b_sandbox = sandbox
+
+    def to_dict(self) -> dict[str, Any]:
+        """Serialize this tool to a dictionary."""
+        return {
+            "type": generate_qualified_class_name(type(self)),
+            "data": {"sandbox": self._e2b_sandbox.to_dict()},
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "WriteFileTool":
+        """Deserialize a WriteFileTool from a dictionary."""
+        sandbox = E2BSandbox.from_dict(data["data"]["sandbox"])
+        return cls(sandbox=sandbox)