Skip to content

Commit e7947a5

Browse files
committed
update readme
1 parent 616322c commit e7947a5

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

apps/sandbox-container/README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
This is a simple MCP-based interface for a sandboxed development environment.
44

5-
## Local dev
5+
## Local Dev
6+
7+
Local dev is currently only supported for Cloudflare employees.
68

79
Cloudchamber local dev isn't implemented yet, so we are doing a bit of a hack to just run the server in your local environment. Because of this, testing the container(s) and container manager locally is not possible at this time.
810

@@ -11,13 +13,15 @@ Do the following from within the sandbox-container app:
1113
1. Copy the `.dev.vars.example` file to a new `.dev.vars` file.
1214
2. Get the Cloudflare client id and secret from a team member and add them to the `.dev.vars` file.
1315
3. Run `pnpm i` then `pnpm dev` to start the MCP server.
14-
4. Run `pnpx @modelcontextprotocol/inspector` to start the MCP inspector client.
16+
4. Run `pnpx @modelcontextprotocol/inspector` to start the MCP inspector client. To avoid potential bugs in newer releases of the inspector, you can specify a version, such as `pnpx @modelcontextprotocol/[email protected]`.
1517
5. Open the inspector client in your browser and connect to the server via `http://localhost:8976/sse`.
1618

1719
Note: Temporary files created through files tool calls are stored in the workdir folder of this app.
1820

1921
## Deploying
2022

23+
Deploying is currently only supported for Cloudflare employees.
24+
2125
1. Make sure the docker daemon is running
2226

2327
2. Disable WARP and run
@@ -26,7 +30,13 @@ Note: Temporary files created through files tool calls are stored in the workdir
2630
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14387504770/npm-package-wrangler-8740 deploy
2731
```
2832

29-
3. Add to your Claude config. If using with Claude, you'll need to disable WARP:
33+
3. Upload the CLOUDFLARE_CLIENT_ID and CLOUDFLARE_CLIENT_SECRET secrets to the deployed Worker.
34+
35+
## Connecting This MCP Server with A Client
36+
37+
To use this MCP server with Claude Desktop:
38+
39+
1. Add the section below to your Claude config.
3040

3141
```
3242
{
@@ -35,14 +45,25 @@ npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14387504
3545
"command": "npx",
3646
"args": [
3747
"mcp-remote",
38-
// this is my deployed instance
39-
"https://container-starter-2.cmsparks.workers.dev/sse"
48+
"https://containers-staging.mcp.cloudflare.com/sse"
4049
]
4150
}
4251
}
4352
}
4453
```
4554

55+
2. If you're using Cloudflare WARP, add the section below to your Claude config:
56+
57+
```
58+
"env": {
59+
"NODE_EXTRA_CA_CERTS": "<path to warp certs file>"
60+
}
61+
```
62+
63+
3. Remove node versions older than 18 from your local machine.
64+
65+
You can read more about using an MCP server with Claude in the [official MCP documentation](https://modelcontextprotocol.io/quickstart/user).
66+
4667
## Tools
4768

4869
- `container_initialize`: (Re)start a container. Containers are intended to be ephemeral and don't save any state. Containers are only guaranteed to last 10m (this is just because I have a max of like ~5 containers per account).

0 commit comments

Comments
 (0)