Skip to content

Commit 3a84740

Browse files
committed
doc: update README.md
1 parent cc21047 commit 3a84740

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -183,22 +183,9 @@ CLICKHOUSE_PASSWORD=clickhouse
183183

184184
The following environment variables are used to configure the ClickHouse and chDB connections:
185185

186-
#### chDB Variables
187-
188-
* `CHDB_ENABLED`: Enable/disable chDB functionality
189-
* Default: `"false"`
190-
* Set to `"true"` to enable chDB tools
191-
* `CHDB_DATA_PATH`: The path to the chDB data directory
192-
* Required when `CHDB_ENABLED=true`
193-
* Use `:memory:` for in-memory database (recommended for testing)
194-
* Use a file path for persistent storage (e.g., `/path/to/chdb/data`)
195-
* `CLICKHOUSE_ENABLED`: Enable/disable ClickHouse functionality
196-
* Default: `"true"`
197-
* Set to `"false"` to disable ClickHouse tools when using chDB only
198-
199186
#### ClickHouse Variables
200187

201-
#### Required Variables
188+
##### Required Variables
202189

203190
* `CLICKHOUSE_HOST`: The hostname of your ClickHouse server
204191
* `CLICKHOUSE_USER`: The username for authentication
@@ -207,7 +194,7 @@ The following environment variables are used to configure the ClickHouse and chD
207194
> [!CAUTION]
208195
> It is important to treat your MCP database user as you would any external client connecting to your database, granting only the minimum necessary privileges required for its operation. The use of default or administrative users should be strictly avoided at all times.
209196
210-
#### Optional Variables
197+
##### Optional Variables
211198

212199
* `CLICKHOUSE_PORT`: The port number of your ClickHouse server
213200
* Default: `8443` if HTTPS is enabled, `8123` if disabled
@@ -230,6 +217,19 @@ The following environment variables are used to configure the ClickHouse and chD
230217
* `CLICKHOUSE_MCP_SERVER_TRANSPORT`: Sets the transport method for the MCP server.
231218
* Default: `"stdio"`
232219
* Valid options: `"stdio"`, `"http"`, `"streamable-http"`, `"sse"`. This is useful for local development with tools like MCP Inspector.
220+
* `CLICKHOUSE_ENABLED`: Enable/disable ClickHouse functionality
221+
* Default: `"true"`
222+
* Set to `"false"` to disable ClickHouse tools when using chDB only
223+
224+
#### chDB Variables
225+
226+
* `CHDB_ENABLED`: Enable/disable chDB functionality
227+
* Default: `"false"`
228+
* Set to `"true"` to enable chDB tools
229+
* `CHDB_DATA_PATH`: The path to the chDB data directory
230+
* Required when `CHDB_ENABLED=true`
231+
* Use `:memory:` for in-memory database (recommended for testing)
232+
* Use a file path for persistent storage (e.g., `/path/to/chdb/data`)
233233

234234
#### Example Configurations
235235

@@ -320,6 +320,8 @@ uv run ruff check . # run linting
320320

321321
docker compose up -d test_services # start ClickHouse
322322
uv run pytest -v tests
323+
uv run pytest -v tests/test_tool.py # ClickHouse only
324+
uv run pytest -v tests/test_chdb_tool.py # chDB only
323325
```
324326

325327
## YouTube Overview

0 commit comments

Comments
 (0)