You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+56-17
Original file line number
Diff line number
Diff line change
@@ -23,29 +23,68 @@ An MCP server for ClickHouse.
23
23
24
24
## Configuration
25
25
26
-
> **Note**: This is a temporary configuration process that will be significantly improved once the package is published.
27
-
28
-
1. Run `uv sync` to install the dependencies. To install `uv` follow the instructions [here](https://docs.astral.sh/uv/). Then do `source .venv/bin/activate`.
29
-
30
-
2. Setup the `.env.production` file with the ClickHouse credentials.
26
+
1. Open the Claude Desktop' configuration file located at:
27
+
- On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
28
+
- On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
31
29
32
-
```
33
-
CLICKHOUSE_HOST=<CLICKHOUSE_HOST>
34
-
CLICKHOUSE_PORT=<CLICKHOUSE_PORT>
35
-
CLICKHOUSE_USER=<CLICKHOUSE_USER>
36
-
CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>
30
+
2. Add the following:
31
+
32
+
```json
33
+
{
34
+
"mcpServers": {
35
+
"mcp-clickhouse": {
36
+
"command": "uv",
37
+
"args": [
38
+
"run",
39
+
"--with",
40
+
"mcp-clickhouse",
41
+
"--python",
42
+
"3.13",
43
+
"mcp-clickhouse"
44
+
],
45
+
"env": {
46
+
"CLICKHOUSE_HOST": "<clickhouse-host>",
47
+
"CLICKHOUSE_PORT": "<clickhouse-port>",
48
+
"CLICKHOUSE_USER": "<clickhouse-user>",
49
+
"CLICKHOUSE_PASSWORD": "<clickhouse-password>"
50
+
}
51
+
}
52
+
}
53
+
}
37
54
```
38
55
39
-
3. Run `fastmcp install mcp_clickhouse/mcp_server.py -f .env.production` to install the server.
40
-
41
-
4. Open the configuration file located at:
42
-
- On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
43
-
- On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
56
+
Update the environment variables to point to your own ClickHouse service.
57
+
58
+
Or, if you'd like to try it out with the [ClickHouse SQL Playground](https://sql.clickhouse.com/), you can use the following config:
Locate the command entry for `uv` and replace it with the absolute path to the `uv` executable. This ensures that the correct version of `uv` is used when starting the server.
46
84
47
-
5. Restart Claude Desktop to apply the changes.
85
+
3. Locate the command entry for `uv` and replace it with the absolute path to the `uv` executable. This ensures that the correct version of `uv` is used when starting the server.
0 commit comments