Skip to content

Commit 29a5d17

Browse files
committed
Document running a local peer with convex-local
Explain that `java -jar convex.jar local start` gives you an MCP endpoint at localhost:8080 that the plugin's convex-local binding connects to out of the box. Note HTTPS, faucet, signing-service, and custom-port caveats.
1 parent 85e7e76 commit 29a5d17

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,24 @@ claude
4848

4949
Disable a server you don't need via Claude Code's `/mcp` panel.
5050

51+
## Running a local peer
52+
53+
The `convex-local` binding connects to `http://localhost:8080/mcp` — the default REST API port of a Convex peer. To run one locally:
54+
55+
```bash
56+
# Download or build convex.jar (see https://github.com/Convex-Dev/convex)
57+
java -jar convex.jar local start
58+
```
59+
60+
That starts a single-peer local lattice with the peer binary protocol on `18888` and the REST/MCP endpoint on `8080`. Open Claude Code and the `convex-local` tools will be live.
61+
62+
Notes for local development:
63+
64+
- **No HTTPS.** The plugin does not block seed-based tools over `http://localhost`, but you should treat local keys as disposable. Do not point `CONVEX_LOCAL_URL` at a plain-HTTP non-localhost peer.
65+
- **Faucet.** `convex local start` configures a faucet by default; `/convex:faucet` works against `convex-local` once you override it to target the local server.
66+
- **Signing service.** Not enabled by default on local peers — the 13 `signing*` tools will be absent unless you configure one. The core 22 tools always work.
67+
- **Custom port.** If you run the peer on a non-default port, set `CONVEX_LOCAL_URL=http://localhost:NNNN/mcp` before launching Claude Code.
68+
5169
## Security notes
5270

5371
- **HTTPS is required for seed-based tools** (`transact`, `signAndSubmit`, `transfer`) since they transmit Ed25519 seeds. Do not point the plugin at a plain-`http://` peer for any signing work beyond local development.

0 commit comments

Comments
 (0)