Skip to content

Commit 2130c90

Browse files
committed
fix: migrate toolbox config to v1.1.0 map-based format
BREAKING: requires MCP Toolbox for Databases v1.0.0+ - tools.yaml: kind-based documents -> map-based sources/tools format - mcp.json: --tools-file -> --config flag - README: update repo URL (genai-toolbox -> mcp-toolbox), min version v1.0.0+
1 parent a4c8902 commit 2130c90

3 files changed

Lines changed: 52 additions & 62 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Install from the [Cursor Marketplace](https://cursor.com/marketplace/cockroachdb
1717

1818
This plugin connects to CockroachDB via MCP (Model Context Protocol). Choose the backend that fits your setup — see [MCP Backends](#mcp-backends) below.
1919

20-
For the **MCP Toolbox** backend (available now), install [MCP Toolbox for Databases](https://github.com/googleapis/genai-toolbox) (v0.27.0+):
20+
For the **MCP Toolbox** backend (available now), install [MCP Toolbox for Databases](https://github.com/googleapis/mcp-toolbox) (v1.0.0+):
2121

2222
```bash
2323
brew install mcp-toolbox
@@ -43,15 +43,15 @@ For CockroachDB Cloud, find connection details in the [Cloud Console](https://co
4343
<details>
4444
<summary><strong>MCP Toolbox</strong> (self-hosted, any cluster) — Default</summary>
4545

46-
Connect to any CockroachDB cluster (Cloud, self-hosted, local) via [MCP Toolbox for Databases](https://github.com/googleapis/genai-toolbox).
46+
Connect to any CockroachDB cluster (Cloud, self-hosted, local) via [MCP Toolbox for Databases](https://github.com/googleapis/mcp-toolbox).
4747

48-
**Install:** `brew install mcp-toolbox` (v0.27.0+)
48+
**Install:** `brew install mcp-toolbox` (v1.0.0+)
4949

50-
**Run (stdio, default):** `toolbox --tools-file tools.yaml --stdio`
50+
**Run (stdio, default):** `toolbox --config tools.yaml --stdio`
5151

52-
**Run (HTTP):** `toolbox --tools-file tools.yaml --address 0.0.0.0 --port 5000`
52+
**Run (HTTP):** `toolbox --config tools.yaml --address 0.0.0.0 --port 5000`
5353

54-
**Run (with web UI):** `toolbox --tools-file tools.yaml --ui --port 5000` (opens at `http://127.0.0.1:5000/ui`)
54+
**Run (with web UI):** `toolbox --config tools.yaml --ui --port 5000` (opens at `http://127.0.0.1:5000/ui`)
5555

5656
> **Note:** Toolbox must successfully connect to CockroachDB on startup. If the database is unreachable (wrong host/port, env vars not set), the server will hang during initialization and the UI will be stuck on "Fetching tools...". Make sure your `COCKROACHDB_*` environment variables are set and the database is accessible before starting.
5757
</details>
@@ -151,7 +151,7 @@ See the [quickstart guide](https://www.cockroachlabs.com/docs/cockroachcloud/con
151151

152152
| Backend | Status | Transport | Use Case |
153153
|----------------------------|-------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|
154-
| `cockroachdb-toolbox` | Active | stdio | Any CockroachDB cluster via [MCP Toolbox](https://github.com/googleapis/genai-toolbox) |
154+
| `cockroachdb-toolbox` | Active | stdio | Any CockroachDB cluster via [MCP Toolbox](https://github.com/googleapis/mcp-toolbox) |
155155
| `cockroachdb-cloud` | Active | Streamable HTTP | [Managed MCP Server](https://www.cockroachlabs.com/blog/cockroachdb-ai-agents-managed-mcp-server/) — CockroachDB Cloud (OAuth/API key) |
156156
| `cockroachdb-toolbox-http` | Available | Streamable HTTP | MCP Toolbox remote/multi-user via HTTP |
157157

@@ -240,7 +240,7 @@ This repo uses [Release Please](https://github.com/googleapis/release-please) fo
240240
- [Cloud MCP Quickstart Guide](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server)
241241
- [ccloud CLI for AI Agents Blog Post](https://www.cockroachlabs.com/blog/cockroachdb-ai-agents-cli-database-automation/)
242242
- [ccloud CLI Reference](https://www.cockroachlabs.com/docs/cockroachcloud/ccloud-get-started)
243-
- [MCP Toolbox for Databases](https://github.com/googleapis/genai-toolbox)
243+
- [MCP Toolbox for Databases](https://github.com/googleapis/mcp-toolbox)
244244
- [Report Issues](https://github.com/cockroachdb/cursor-plugin/issues)
245245

246246
## License

mcp.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"mcpServers": {
33
"cockroachdb-toolbox": {
44
"command": "toolbox",
5-
"args": ["--tools-file", "tools.yaml", "--stdio"],
5+
"args": ["--config", "tools.yaml", "--stdio"],
66
"env": {
77
"COCKROACHDB_HOST": "${COCKROACHDB_HOST}",
88
"COCKROACHDB_PORT": "${COCKROACHDB_PORT}",
@@ -15,7 +15,7 @@
1515
"cockroachdb-toolbox-http": {
1616
"type": "http",
1717
"url": "http://127.0.0.1:5000/mcp",
18-
"_comment": "Streamable HTTP transport — run 'toolbox --tools-file tools.yaml' first, then connect via this URL"
18+
"_comment": "Streamable HTTP transport — run 'toolbox --config tools.yaml' first, then connect via this URL"
1919
},
2020
"cockroachdb-cloud": {
2121
"type": "http",

tools.yaml

Lines changed: 42 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,42 @@
1-
kind: sources
2-
name: crdb-source
3-
type: cockroachdb
4-
host: ${COCKROACHDB_HOST}
5-
port: "${COCKROACHDB_PORT:26257}"
6-
database: ${COCKROACHDB_DATABASE}
7-
user: ${COCKROACHDB_USER}
8-
password: ${COCKROACHDB_PASSWORD}
9-
maxRetries: 5
10-
retryBaseDelay: 500ms
11-
readOnlyMode: true
12-
enableWriteMode: false
13-
maxRowLimit: 1000
14-
queryTimeoutSec: 30
15-
queryParams:
16-
sslmode: ${COCKROACHDB_SSLMODE:require}
17-
application_name: cockroachdb-cursor-plugin
18-
19-
---
20-
21-
kind: tools
22-
name: cockroachdb-execute-sql
23-
type: cockroachdb-execute-sql
24-
source: crdb-source
25-
description: |
26-
Execute ad-hoc SQL statements against a CockroachDB database.
27-
Use this for any SQL: SELECT queries, DDL statements (CREATE, ALTER, DROP),
28-
and DML statements (INSERT, UPDATE, DELETE).
29-
30-
---
31-
32-
kind: tools
33-
name: cockroachdb-list-schemas
34-
type: cockroachdb-list-schemas
35-
source: crdb-source
36-
description: |
37-
List all schemas in the connected CockroachDB database.
38-
Returns schema names and metadata. Use this as the first step
39-
when exploring an unfamiliar database.
40-
41-
---
42-
43-
kind: tools
44-
name: cockroachdb-list-tables
45-
type: cockroachdb-list-tables
46-
source: crdb-source
47-
description: |
48-
List all tables in a CockroachDB database with detailed schema information
49-
including column names, data types, constraints, and indexes.
50-
Use this to understand table structure before writing queries.
51-
52-
1+
sources:
2+
crdb-source:
3+
type: cockroachdb
4+
host: ${COCKROACHDB_HOST:localhost}
5+
port: "${COCKROACHDB_PORT:26257}"
6+
user: ${COCKROACHDB_USER:root}
7+
password: ${COCKROACHDB_PASSWORD:}
8+
database: ${COCKROACHDB_DATABASE:defaultdb}
9+
maxRetries: 5
10+
retryBaseDelay: 500ms
11+
readOnlyMode: true
12+
enableWriteMode: false
13+
maxRowLimit: 1000
14+
queryTimeoutSec: 30
15+
queryParams:
16+
sslmode: ${COCKROACHDB_SSLMODE:require}
17+
application_name: cockroachdb-cursor-plugin
18+
19+
tools:
20+
cockroachdb-execute-sql:
21+
type: cockroachdb-execute-sql
22+
source: crdb-source
23+
description: |
24+
Execute ad-hoc SQL statements against a CockroachDB database.
25+
Use this for any SQL: SELECT queries, DDL statements (CREATE, ALTER, DROP),
26+
and DML statements (INSERT, UPDATE, DELETE).
27+
28+
cockroachdb-list-schemas:
29+
type: cockroachdb-list-schemas
30+
source: crdb-source
31+
description: |
32+
List all schemas in the connected CockroachDB database.
33+
Returns schema names and metadata. Use this as the first step
34+
when exploring an unfamiliar database.
35+
36+
cockroachdb-list-tables:
37+
type: cockroachdb-list-tables
38+
source: crdb-source
39+
description: |
40+
List all tables in a CockroachDB database with detailed schema information
41+
including column names, data types, constraints, and indexes.
42+
Use this to understand table structure before writing queries.

0 commit comments

Comments
 (0)