> ## 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.
# Code Mode
> Code execution configuration, methods, executor classes, and result types for the TypeScript MCP client.
View the client source on GitHub: [https://github.com/mcp-use/mcp-use/blob/main/libraries/typescript/packages/mcp-use/src/client.ts](https://github.com/mcp-use/mcp-use/blob/main/libraries/typescript/packages/mcp-use/src/client.ts)
View the executor base types: [https://github.com/mcp-use/mcp-use/blob/main/libraries/typescript/packages/mcp-use/src/client/executors/base.ts](https://github.com/mcp-use/mcp-use/blob/main/libraries/typescript/packages/mcp-use/src/client/executors/base.ts)
View the Code Mode connector: [https://github.com/mcp-use/mcp-use/blob/main/libraries/typescript/packages/mcp-use/src/client/connectors/codeMode.ts](https://github.com/mcp-use/mcp-use/blob/main/libraries/typescript/packages/mcp-use/src/client/connectors/codeMode.ts)
Code Mode adds code execution to `MCPClient`. When enabled, the client exposes `executeCode()` and `searchTools()`, and the internal Code Mode connector provides `execute_code` and `search_tools` tools for agents.
Import the client and public executor types from `mcp-use`:
```ts theme={null}
import { BaseCodeExecutor, MCPClient } from "mcp-use";
import type {
CodeModeConfig,
E2BExecutorOptions,
ExecutionResult,
VMExecutorOptions,
} from "mcp-use";
```
## Enable Code Mode
Set `codeMode: true` to use the default VM executor. Pass `CodeModeConfig` when you need E2B, a custom executor function, a custom executor class, or executor options.
**Signature**
```ts wrap theme={null}
interface MCPClientOptions {
codeMode?: boolean | CodeModeConfig;
}
```
## CodeModeConfig
Advanced configuration for code execution mode.
**Fields**
> Whether code execution mode is enabled.
> Executor implementation. Defaults to `"vm"`.
> Executor-specific options.
**Signature**
```ts wrap theme={null}
interface CodeModeConfig {
enabled: boolean;
executor?: "vm" | "e2b" | CodeExecutorFunction | BaseCodeExecutor;
executorOptions?: VMExecutorOptions | E2BExecutorOptions;
}
```
## Executor options
### VMExecutorOptions
Options for the Node.js VM executor.
**Fields**
> Maximum execution time in milliseconds. Defaults to `30000`.
> Optional memory limit in megabytes. When omitted, no memory limit is configured.
**Signature**
```ts wrap theme={null}
interface VMExecutorOptions {
timeoutMs?: number;
memoryLimitMb?: number;
}
```
### E2BExecutorOptions
Options for the E2B cloud sandbox executor.
**Fields**
> E2B API key. Required.
> Maximum execution time in milliseconds. Defaults to `300000`.
**Signature**
```ts wrap theme={null}
interface E2BExecutorOptions {
apiKey: string;
timeoutMs?: number;
}
```
## MCPClient methods
### executeCode
Executes JavaScript or TypeScript code with access to connected MCP tools. Code Mode must be enabled.
**Parameters**
> Code to execute.
> Per-execution timeout in milliseconds.
**Returns**
>
**Throws**
Throws `Error` when Code Mode is not enabled.
**Signature**
```ts wrap theme={null}
executeCode(code: string, timeout?: number): Promise
```
### searchTools
Searches tools across active MCP sessions. Code Mode must be enabled.
**Parameters**
> Search query. Empty string returns all tools.
> Amount of detail to return for each matching tool.
**Returns**
>
**Throws**
Throws `Error` when Code Mode is not enabled.
**Signature**
```ts wrap theme={null}
searchTools(
query?: string,
detailLevel?: "names" | "descriptions" | "full"
): Promise
```
### close
Closes the client. When Code Mode has created an executor, `close()` cleans up executor resources before closing sessions.
**Returns**
>
**Signature**
```ts wrap theme={null}
close(): Promise
```
## ExecutionResult
Result returned by `executeCode()`.
**Fields**
> Return value from the executed code.
> Console output captured during execution.
> Error message when execution failed, otherwise `null`.
> Execution duration in seconds.
**Signature**
```ts wrap theme={null}
interface ExecutionResult {
result: unknown;
logs: string[];
error: string | null;
execution_time: number;
}
```
## Tool search types
### ToolSearchResponse
Response returned by `searchTools()` and by the runtime `search_tools()` helper available inside executed code.
**Fields**
> Search metadata, including total tool count and namespaces.
> Matching tools.
**Signature**
```ts wrap theme={null}
interface ToolSearchResponse {
meta: ToolSearchMeta;
results: ToolSearchResult[];
}
```
### ToolSearchMeta
**Fields**
> Total number of tools across active sessions before filtering.
> Sorted server namespaces that have tools.
> Number of matching tools returned in `results`.
**Signature**
```ts wrap theme={null}
interface ToolSearchMeta {
total_tools: number;
namespaces: string[];
result_count: number;
}
```
### ToolSearchResult
**Fields**
> Tool name.
> Server namespace.
> Tool description. Included when `detailLevel` is `"descriptions"` or `"full"`.
> Tool input schema. Included when `detailLevel` is `"full"`.
**Signature**
```ts wrap theme={null}
interface ToolSearchResult {
name: string;
server: string;
description?: string;
input_schema?: Tool["inputSchema"];
}
```
## Custom executors
### CodeExecutorFunction
Function form for a custom executor.
**Signature**
```ts wrap theme={null}
type CodeExecutorFunction = (
code: string,
timeout?: number
) => Promise
```
### BaseCodeExecutor
Extend `BaseCodeExecutor` when a custom executor needs access to MCP sessions, namespaces, and the shared tool search function.
**Constructor parameters**
> Client whose configured servers should be exposed to executed code.
**Methods**
> Runs code. Subclasses must implement this method.
> Releases executor resources. Subclasses must implement this method.
> Returns the runtime tool search helper.
> Protected helper that connects missing configured servers before execution.
> Protected helper that returns active server namespaces and tools, excluding the internal `code_mode` server.
**Signature**
```ts wrap theme={null}
abstract class BaseCodeExecutor {
constructor(client: MCPClient);
abstract execute(code: string, timeout?: number): Promise;
abstract cleanup(): Promise;
public createSearchToolsFunction(): SearchToolsFunction;
protected ensureServersConnected(): Promise;
protected getToolNamespaces(): ToolNamespaceInfo[];
}
```
## Related
* [Code Mode](/typescript/client/code-mode): guide to enabling Code Mode and choosing an executor.
* [`MCPClient`](/typescript/api-reference/client/mcp-client): complete client constructor, lifecycle, configuration, and session APIs.
* [Building agents](/typescript/agent): agent setup with MCP tools.