@yukkit/e2b-mcp-server 0.2.0 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +222 -22
  3. package/package.json +7 -8
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2023 FoundryLabs, Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,49 +1,249 @@
1
- # E2B MCP Server (JavaScript)
1
+ # E2B MCP Server
2
2
 
3
- A Model Context Protocol server for running code in a secure sandbox by [E2B](https://e2b.dev).
3
+ [![npm version](https://img.shields.io/npm/v/@yukkit/e2b-mcp-server.svg)](https://www.npmjs.com/package/@yukkit/e2b-mcp-server)
4
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
5
+ ![Node version](https://img.shields.io/node/v/@yukkit/e2b-mcp-server.svg)
6
+ [![TypeScript](https://img.shields.io/badge/TypeScript-blue?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
4
7
 
5
- ## Development
8
+ A production-grade Model Context Protocol server that provides secure code execution capabilities through [E2B](https://e2b.dev) sandboxes. This implementation enables AI models and assistants to execute code, manage files, and interact with isolated development environments safely.
6
9
 
7
- Install dependencies:
8
- ```
9
- pnpm install
10
- ```
10
+ ## Overview
11
11
 
12
- Build the server:
13
- ```
14
- pnpm build
12
+ This server implements the [Model Context Protocol (MCP)](https://modelcontextprotocol.io) to expose E2B's secure sandbox infrastructure as a set of tools that can be used by AI models like Claude. It features a robust architecture with resource management, comprehensive error handling, and production-ready logging.
13
+
14
+ **Key capabilities:**
15
+
16
+ - Execute Python code in isolated sandboxes with configurable timeouts
17
+ - Run shell commands (foreground and background modes)
18
+ - Manage files (read, write, list) within sandbox environments
19
+ - Expose sandbox services via public URLs
20
+ - Automatic resource cleanup and lifecycle management
21
+ - Support for multiple concurrent sandboxes with configurable limits
22
+
23
+ ## Features
24
+
25
+ - **8 Production-Ready Tools**: Complete toolkit for sandbox interaction
26
+ - **Resource Management**: Automatic sandbox lifecycle management with configurable limits (default: 10 concurrent sandboxes)
27
+ - **Robust Error Handling**: Custom error classes for clear diagnostics (SandboxError, SandboxNotFoundError, SandboxLimitExceededError)
28
+ - **Production Logging**: Multi-level logging system (DEBUG, INFO, WARNING, ERROR) with timestamps
29
+ - **Input Validation**: Comprehensive Zod schemas for all tool inputs
30
+ - **Graceful Shutdown**: Proper cleanup on SIGINT/SIGTERM signals
31
+ - **Zero Configuration**: Works out of the box with sensible defaults
32
+
33
+ ## Installation
34
+
35
+ ### Quick Start with npx
36
+
37
+ The fastest way to use the server is with npx:
38
+
39
+ ```bash
40
+ npx @yukkit/e2b-mcp-server
15
41
  ```
16
42
 
17
- For development with auto-rebuild:
43
+ ### Global Installation
44
+
45
+ ```bash
46
+ npm install -g @yukkit/e2b-mcp-server
18
47
  ```
19
- pnpm watch
48
+
49
+ ### Project Installation
50
+
51
+ ```bash
52
+ npm install @yukkit/e2b-mcp-server
20
53
  ```
21
54
 
22
- ## Installation
55
+ ## Usage
56
+
57
+ ### With Claude Desktop
23
58
 
24
- To use with Claude Desktop, add the server config:
59
+ Add the server configuration to your Claude Desktop config file:
25
60
 
26
- On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
27
- On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
61
+ **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
62
+ **Windows**: `%APPDATA%/Claude/claude_desktop_config.json`
28
63
 
29
64
  ```json
30
65
  {
31
66
  "mcpServers": {
32
- "e2b-server": {
67
+ "e2b": {
33
68
  "command": "npx",
34
- "args": ["-y", "@e2b/mcp-server"],
35
- "env": { "E2B_API_KEY": "${e2bApiKey}" }
69
+ "args": ["-y", "@yukkit/e2b-mcp-server"],
70
+ "env": {
71
+ "E2B_API_KEY": "your-api-key-here"
72
+ }
36
73
  }
37
74
  }
38
75
  }
39
76
  ```
40
77
 
41
- ### Debugging
78
+ > [!IMPORTANT]
79
+ > You need an E2B API key to use this server. Get one for free at [e2b.dev](https://e2b.dev).
80
+
81
+ ### With Other MCP Clients
82
+
83
+ Any MCP-compatible client can use this server by running:
84
+
85
+ ```bash
86
+ E2B_API_KEY=your-api-key-here e2b-mcp-server
87
+ ```
88
+
89
+ ### Configuration
90
+
91
+ Configure the server using environment variables:
92
+
93
+ | Variable | Description | Default |
94
+ |----------|-------------|---------|
95
+ | `E2B_API_KEY` | Your E2B API key (required) | - |
96
+ | `MAX_ACTIVE_SANDBOXES` | Maximum concurrent sandboxes | `10` |
97
+ | `LOG_LEVEL` | Logging verbosity (DEBUG, INFO, WARNING, ERROR) | `INFO` |
98
+
99
+ Example with custom configuration:
100
+
101
+ ```bash
102
+ E2B_API_KEY=your-key MAX_ACTIVE_SANDBOXES=5 LOG_LEVEL=DEBUG e2b-mcp-server
103
+ ```
104
+
105
+ ## Available Tools
106
+
107
+ ### 1. create_sandbox
108
+
109
+ Create a new isolated code execution sandbox.
110
+
111
+ **Parameters:**
112
+
113
+ - `timeoutMs` (optional): Sandbox timeout in milliseconds (default: 300000, max: 3600000)
114
+
115
+ ### 2. run_code
116
+
117
+ Execute Python code in a sandbox.
118
+
119
+ **Parameters:**
120
+
121
+ - `code`: Python code to execute
122
+ - `sandboxId` (optional): Target sandbox ID. If not provided, creates a temporary sandbox.
123
+
124
+ ### 3. run_command
125
+
126
+ Execute a shell command in a sandbox.
127
+
128
+ **Parameters:**
129
+
130
+ - `command`: Shell command to run
131
+ - `sandboxId`: Target sandbox ID
132
+ - `background`: Run in background (default: false)
133
+
134
+ ### 4. read_file
135
+
136
+ Read file contents from a sandbox.
137
+
138
+ **Parameters:**
42
139
 
43
- Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:
140
+ - `filePath`: Path to the file
141
+ - `sandboxId`: Target sandbox ID
44
142
 
143
+ ### 5. write_file
144
+
145
+ Write content to a file in a sandbox.
146
+
147
+ **Parameters:**
148
+
149
+ - `filePath`: Path to the file
150
+ - `fileContents`: Content to write
151
+ - `sandboxId`: Target sandbox ID
152
+
153
+ ### 6. list_files
154
+
155
+ List files in a directory within a sandbox.
156
+
157
+ **Parameters:**
158
+
159
+ - `folderPath`: Directory path to list
160
+ - `sandboxId`: Target sandbox ID
161
+
162
+ ### 7. get_sandbox_url
163
+
164
+ Get a public URL for accessing a service running in a sandbox.
165
+
166
+ **Parameters:**
167
+
168
+ - `port`: Port number (1-65535)
169
+ - `sandboxId`: Target sandbox ID
170
+
171
+ ### 8. kill_sandbox
172
+
173
+ Terminate a sandbox and clean up resources.
174
+
175
+ **Parameters:**
176
+
177
+ - `sandboxId`: Target sandbox ID
178
+
179
+ ## Development
180
+
181
+ ### Prerequisites
182
+
183
+ - Node.js >= 20
184
+ - pnpm (recommended) or npm
185
+
186
+ ### Setup
187
+
188
+ Clone the repository and install dependencies:
189
+
190
+ ```bash
191
+ git clone https://github.com/yukkit/e2b-mcp-server.git
192
+ cd e2b-mcp-server/packages/js
193
+ pnpm install
194
+ ```
195
+
196
+ ### Building
197
+
198
+ Build the TypeScript source:
199
+
200
+ ```bash
201
+ pnpm build
202
+ ```
203
+
204
+ For development with automatic rebuilding:
205
+
206
+ ```bash
207
+ pnpm watch
45
208
  ```
209
+
210
+ ### Debugging
211
+
212
+ Since MCP servers communicate over stdio, debugging can be challenging. Use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) for interactive debugging:
213
+
214
+ ```bash
46
215
  pnpm inspector
47
216
  ```
48
217
 
49
- The Inspector will provide a URL to access debugging tools in your browser.
218
+ This will start the inspector and provide a URL to access debugging tools in your browser.
219
+
220
+ ## Architecture
221
+
222
+ The server is built with a modular architecture:
223
+
224
+ - **SandboxManager**: Handles sandbox lifecycle and resource limits
225
+ - **Logger**: Provides structured logging with multiple levels
226
+ - **Error Classes**: Custom exceptions for clear error handling
227
+ - **Zod Schemas**: Input validation for all tools
228
+ - **MCP Server**: Standard MCP protocol implementation
229
+
230
+ ## Troubleshooting
231
+
232
+ ### "Need to provide E2B_API_KEY"
233
+
234
+ Set your E2B API key as an environment variable. Get one at [e2b.dev](https://e2b.dev).
235
+
236
+ ### "Maximum number of active sandboxes reached"
237
+
238
+ The default limit is 10 concurrent sandboxes. Increase it with `MAX_ACTIVE_SANDBOXES` or terminate unused sandboxes with the `kill_sandbox` tool.
239
+
240
+ ### Connection Issues
241
+
242
+ Ensure your firewall allows outbound connections to E2B's API endpoints.
243
+
244
+ ## Resources
245
+
246
+ - [E2B Documentation](https://e2b.dev/docs)
247
+ - [Model Context Protocol](https://modelcontextprotocol.io)
248
+ - [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)
249
+ - [Claude Desktop](https://claude.ai/download)
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@yukkit/e2b-mcp-server",
3
- "version": "0.2.0",
3
+ "version": "0.2.2",
4
4
  "description": "A Model Context Protocol server",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "https://github.com/e2b-dev/mcp-server",
7
+ "url": "https://github.com/yukkit/e2b-mcp-server",
8
8
  "directory": "packages/js"
9
9
  },
10
10
  "type": "module",
@@ -14,12 +14,6 @@
14
14
  "files": [
15
15
  "build"
16
16
  ],
17
- "scripts": {
18
- "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
19
- "prepare": "npm run build",
20
- "watch": "tsc --watch",
21
- "inspector": "npx @modelcontextprotocol/inspector build/index.js"
22
- },
23
17
  "dependencies": {
24
18
  "@e2b/code-interpreter": "^1.0.4",
25
19
  "@modelcontextprotocol/sdk": "1.25.2",
@@ -30,5 +24,10 @@
30
24
  "devDependencies": {
31
25
  "@types/node": "^20.11.24",
32
26
  "typescript": "^5.3.3"
27
+ },
28
+ "scripts": {
29
+ "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
30
+ "watch": "tsc --watch",
31
+ "inspector": "npx @modelcontextprotocol/inspector build/index.js"
33
32
  }
34
33
  }