Skip to content

Commit b0f3005

Browse files
committed
docs: document scripts/ folder and local cluster helper in README
1 parent 2b40c6b commit b0f3005

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,20 @@ For the **MCP Toolbox** backend (available now), install [MCP Toolbox for Databa
2323
brew install mcp-toolbox
2424
```
2525

26+
### Local Cluster (optional)
27+
28+
Need a local CockroachDB to point the agent at? The repo ships a helper script that provisions a local multi-node insecure cluster on `localhost`:
29+
30+
```bash
31+
./scripts/setup-cockroachdb.sh start # start the cluster
32+
./scripts/setup-cockroachdb.sh status # show running nodes
33+
./scripts/setup-cockroachdb.sh stop # stop nodes (data preserved)
34+
./scripts/setup-cockroachdb.sh destroy # stop and remove all data
35+
./scripts/setup-cockroachdb.sh --help # all options (--nodes, --version, --port, ...)
36+
```
37+
38+
The matching `setting-up-local-cluster` skill walks the agent through using it.
39+
2640
## Configuration
2741

2842
Set environment variables for your CockroachDB connection:
@@ -215,9 +229,11 @@ cd cursor-plugin
215229
### Project Structure
216230

217231
```
218-
.cursor-plugin/plugin.json # Plugin manifest
232+
.cursor-plugin/plugin.json # Plugin manifest
219233
skills/ # Skills from cockroachdb-skills submodule
220-
rules/ # 4 rule sets (.mdc files)
234+
rules/ # Rule sets (.mdc files)
235+
scripts/
236+
setup-cockroachdb.sh # Local multi-node cluster provisioning script
221237
mcp.json # MCP server definitions (Toolbox + Cloud MCP)
222238
tools.yaml # Toolbox source & tool configuration
223239
submodules/cockroachdb-skills # Shared skills submodule

0 commit comments

Comments
 (0)