Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mcp-use.com/llms.txt

Use this file to discover all available pages before exploring further.

View the source code for this module on GitHub: https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/client/connectors/sandbox.py
Sandbox connector for MCP implementations. This module provides a connector for communicating with MCP implementations that are executed inside a sandbox environment (currently using E2B).

​
SandboxConnector

from mcp_use.client.connectors.sandbox import SandboxConnector

​
method init

Initialize a new sandbox connector.Parameters
​
command
str
required
String value
​
args
list[str]
required
List of items
​
env
dict[str, str] | None
default:"None"
Environment variables for the user’s MCP server command.
​
e2b_options
mcp_use.client.connectors.sandbox.SandboxOptions | None
default:"None"
Configuration options for the E2B sandbox environment.
​
timeout
float
default:"5"
Timeout for the sandbox process in seconds.
​
sse_read_timeout
float
default:"300"
Timeout for the SSE connection in seconds.
​
sampling_callback
mcp.client.session.SamplingFnT | None
default:"None"
Optional sampling callback.
​
elicitation_callback
mcp.client.session.ElicitationFnT | None
default:"None"
Optional elicitation callback.
​
message_handler
mcp.client.session.MessageHandlerFnT | None
default:"None"
Optional callback to handle messages.
​
logging_callback
mcp.client.session.LoggingFnT | None
default:"None"
Optional callback to handle log messages.
​
middleware
list[mcp_use.client.middleware.middleware.Middleware] | None
default:"None"
Optional list of middleware.
​
roots
list[mcp.types.Root] | None
default:"None"
Optional initial list of roots to advertise to the server.
​
list_roots_callback
mcp.client.session.ListRootsFnT | None
default:"None"
Optional custom callback to handle roots/list requests.
Signature
def __init__(command: str, args: list[str], env: dict[str, str] | None = None, e2b_options: mcp_use.client.connectors.sandbox.SandboxOptions | None = None, timeout: float = 5, sse_read_timeout: float = 300, sampling_callback: mcp.client.session.SamplingFnT | None = None, elicitation_callback: mcp.client.session.ElicitationFnT | None = None, message_handler: mcp.client.session.MessageHandlerFnT | None = None, logging_callback: mcp.client.session.LoggingFnT | None = None, middleware: list[mcp_use.client.middleware.middleware.Middleware] | None = None, roots: list[mcp.types.Root] | None = None, list_roots_callback: mcp.client.session.ListRootsFnT | None = None):

​
method wait_for_server_response

Wait for the server to respond to HTTP requests.Parameters
​
base_url
str
required
The base URL to check for server readiness
​
timeout
int
default:"30"
Maximum time to wait in seconds
Returns
​
returns
bool
True if server is responding, raises TimeoutError otherwise
Signature
def wait_for_server_response(base_url: str, timeout: int = 30):

​
SandboxOptions

from mcp_use.client.connectors.sandbox import SandboxOptions

Attributes
​
api_key
str
required
String value
​
sandbox_template_id
NotRequired
required
Parameter value
​
supergateway_command
NotRequired
required
Parameter value

​
method init

Initialize self. See help(type(self)) for accurate signature.Parameters
​
args
required
Parameter value
​
kwargs
required
Parameter value
Signature
def __init__(args, kwargs):