Skip to content

Commit 2400c96

Browse files
committed
docs: document scripts/ folder and local cluster helper in README
1 parent 7858cde commit 2400c96

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,20 @@ This plugin connects to CockroachDB via MCP (Model Context Protocol) using [MCP
2727
brew install mcp-toolbox
2828
```
2929

30+
### Local Cluster (optional)
31+
32+
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`:
33+
34+
```bash
35+
./scripts/setup-cockroachdb.sh start # start the cluster
36+
./scripts/setup-cockroachdb.sh status # show running nodes
37+
./scripts/setup-cockroachdb.sh stop # stop nodes (data preserved)
38+
./scripts/setup-cockroachdb.sh destroy # stop and remove all data
39+
./scripts/setup-cockroachdb.sh --help # all options (--nodes, --version, --port, ...)
40+
```
41+
42+
The matching `setting-up-local-cluster` skill walks the agent through using it.
43+
3044
## Configuration
3145

3246
Set environment variables for your CockroachDB connection:
@@ -272,8 +286,10 @@ agents/
272286
hooks/
273287
hooks.json # Hook configuration
274288
scripts/
289+
setup-cockroachdb.sh # Local multi-node cluster provisioning script
275290
validate-sql.py # SQL validation hook
276291
check-sql-files.py # Anti-pattern linter hook
292+
validate-marketplace-install.sh # Marketplace install verification
277293
skills/ # Skills copied from cockroachdb-skills submodule
278294
submodules/
279295
cockroachdb-skills/ # Shared skills submodule

0 commit comments

Comments
 (0)