Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

Add mcp server prepull (#975)

Jonas Scholz68abd92c4088
diff --git a/.changeset/plenty-games-play.md b/.changeset/plenty-games-play.md
new file mode 100644
index 000000000..a2eb85955
--- /dev/null
+++ b/.changeset/plenty-games-play.md
@@ -0,0 +1,6 @@
+---
+'@e2b/python-sdk': patch
+'e2b': patch
+---
+
+add prepulling of mcp servers
diff --git a/packages/js-sdk/src/template/index.ts b/packages/js-sdk/src/template/index.ts
index a732ec7ee..c106e0ecc 100644
--- a/packages/js-sdk/src/template/index.ts
+++ b/packages/js-sdk/src/template/index.ts
@@ -1,6 +1,7 @@
import type { PathLike } from 'node:fs'
import { ApiClient } from '../api'
import { ConnectionConfig } from '../connectionConfig'
+import { BuildError } from '../errors'
import { runtime } from '../utils'
import {
getFileUploadLink,
@@ -19,6 +20,7 @@ import {
CopyItem,
Instruction,
InstructionType,
+ McpServerName,
RegistryConfig,
TemplateBuilder,
TemplateClass,
@@ -479,6 +481,22 @@ export class TemplateBase
)
}
+ betaAddMcpServer(servers: McpServerName | McpServerName[]): TemplateBuilder {
+ if (this.baseTemplate !== 'mcp-gateway') {
+ throw new BuildError(
+ 'MCP servers can only be added to mcp-gateway template',
+ getCallerFrame(STACK_TRACE_DEPTH - 1)
+ )
+ }
+
+ const serverList = Array.isArray(servers) ? servers : [servers]
+ return this.runInNewStackTraceContext(() =>
+ this.runCmd(`mcp-gateway pull ${serverList.join(' ')}`, {
+ user: 'root',
+ })
+ )
+ }
+
gitClone(
url: string,
path?: PathLike,
@@ -896,6 +914,7 @@ Template.toDockerfile = TemplateBase.toDockerfile
export type {
BuildOptions,
CopyItem,
+ McpServerName,
TemplateBuilder,
TemplateClass,
} from './types'
diff --git a/packages/js-sdk/src/template/types.ts b/packages/js-sdk/src/template/types.ts
index d6ad942f8..a56a5441b 100644
--- a/packages/js-sdk/src/template/types.ts
+++ b/packages/js-sdk/src/template/types.ts
@@ -1,6 +1,7 @@
import { ReadyCmd } from './readycmd'
import type { PathLike } from 'node:fs'
import type { LogEntry } from './logger'
+import type { McpServer } from '../sandbox/mcp'
/**
* Options for creating a new template.
@@ -95,6 +96,11 @@ export type CopyItem = {
resolveSymlinks?: boolean
}
+/**
+ * MCP server names that can be installed.
+ */
+export type McpServerName = keyof McpServer
+
/**
* Initial state of a template builder.
* Use one of these methods to specify the base image or template to start from.
@@ -468,6 +474,20 @@ export interface TemplateBuilder {
*/
aptInstall(packages: string | string[]): TemplateBuilder
+ /**
+ * Install MCP servers using mcp-gateway.
+ * Note: Requires a base image with mcp-gateway pre-installed (e.g., mcp-gateway).
+ * @param servers MCP server name(s)
+ *
+ * @throws {Error} If the base template is not mcp-gateway
+ * @example
+ * ```ts
+ * template.betaAddMcpServer('exa')
+ * template.betaAddMcpServer(['brave', 'firecrawl', 'duckduckgo'])
+ * ```
+ */
+ betaAddMcpServer(servers: McpServerName | McpServerName[]): TemplateBuilder
+
/**
* Clone a Git repository.
* @param url Repository URL
diff --git a/packages/js-sdk/tests/template/stacktrace.test.ts b/packages/js-sdk/tests/template/stacktrace.test.ts
index 8c526ecfd..96630cb0b 100644
--- a/packages/js-sdk/tests/template/stacktrace.test.ts
+++ b/packages/js-sdk/tests/template/stacktrace.test.ts
@@ -242,3 +242,10 @@ buildTemplateTest('traces on setStartCmd', async ({ buildTemplate }) => {
await buildTemplate(template)
}, 'setStartCmd')
})
+
+buildTemplateTest('traces on betaAddMcpServer', async () => {
+ // needs mcp-gateway as base template, without it no mcp servers can be added
+ await expectToThrowAndCheckTrace(async () => {
+ Template().fromBaseImage().betaAddMcpServer('exa')
+ }, 'betaAddMcpServer')
+})
diff --git a/packages/python-sdk/e2b/template/main.py b/packages/python-sdk/e2b/template/main.py
index e2485cea7..4735bed9a 100644
--- a/packages/python-sdk/e2b/template/main.py
+++ b/packages/python-sdk/e2b/template/main.py
@@ -4,6 +4,7 @@ from pathlib import Path
from httpx import Limits
+from e2b.exceptions import BuildException
from e2b.template.consts import STACK_TRACE_DEPTH, RESOLVE_SYMLINKS
from e2b.template.dockerfile_parser import parse_dockerfile
from e2b.template.readycmd import ReadyCmd
@@ -415,6 +416,43 @@ class TemplateBuilder:
)
)
+ def beta_add_mcp_server(self, servers: Union[str, List[str]]) -> "TemplateBuilder":
+ """
+ Install MCP servers using mcp-gateway.
+
+ Note: Requires a base image with mcp-gateway pre-installed (e.g., mcp-gateway).
+
+ :param servers: MCP server name(s)
+
+ :return: `TemplateBuilder` class
+
+ Example
+ ```python
+ template.beta_add_mcp_server('exa')
+ template.beta_add_mcp_server(['brave', 'firecrawl', 'duckduckgo'])
+ ```
+ """
+ if self._template._base_template != "mcp-gateway":
+ caller_frame = get_caller_frame(STACK_TRACE_DEPTH - 1)
+ stack_trace = None
+ if caller_frame is not None:
+ stack_trace = TracebackType(
+ tb_next=None,
+ tb_frame=caller_frame,
+ tb_lasti=caller_frame.f_lasti,
+ tb_lineno=caller_frame.f_lineno,
+ )
+ raise BuildException(
+ "MCP servers can only be added to mcp-gateway template"
+ ).with_traceback(stack_trace)
+
+ if isinstance(servers, str):
+ servers = [servers]
+
+ return self._template._run_in_new_stack_trace_context(
+ lambda: self.run_cmd(f"mcp-gateway pull {' '.join(servers)}", user="root")
+ )
+
def git_clone(
self,
url: str,
diff --git a/packages/python-sdk/tests/async/template_async/test_stacktrace.py b/packages/python-sdk/tests/async/template_async/test_stacktrace.py
index 48e9fea1a..d1cf52982 100644
--- a/packages/python-sdk/tests/async/template_async/test_stacktrace.py
+++ b/packages/python-sdk/tests/async/template_async/test_stacktrace.py
@@ -208,3 +208,12 @@ async def test_traces_on_start_cmd(async_build):
await _expect_to_throw_and_check_trace(
lambda: async_build(template), "set_start_cmd"
)
+
+
+async def test_traces_on_beta_add_mcp_server():
+ # needs mcp-gateway as base template, without it no mcp servers can be added
+ await _expect_to_throw_and_check_trace(
+ lambda: AsyncTemplate().from_base_image().beta_add_mcp_server("exa"),
+ "beta_add_mcp_server",
+ )
diff --git a/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py b/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py
index 582452c4b..8ad4f31d8 100644
--- a/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py
+++ b/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py
@@ -196,3 +196,12 @@ def test_traces_on_set_start_cmd(build):
f"./{non_existent_path}", wait_for_timeout(10_000)
)
_expect_to_throw_and_check_trace(lambda: build(template), "set_start_cmd")
+
+
+def test_traces_on_beta_add_mcp_server():
+ # needs mcp-gateway as base template, without it no mcp servers can be added
+ _expect_to_throw_and_check_trace(
+ lambda: Template().from_base_image().beta_add_mcp_server("exa"),
+ "beta_add_mcp_server",
+ )