Skip to content

Commit 5d94fda

Browse files
committed
docs: simplify README to focus on Cloud setup
Remove self-hosted and SQL Playground configs from README — the detailed configuration options are already in POWER.md. Quick Start now focuses on the Cloud path with a note pointing to alternatives.
1 parent 9afa869 commit 5d94fda

1 file changed

Lines changed: 3 additions & 65 deletions

File tree

README.md

Lines changed: 3 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,12 @@ Kiro will run the right SQL, interpret the results, and give you actionable advi
2222
- [Kiro IDE](https://kiro.dev) installed
2323
- A ClickHouse database (Cloud, self-hosted, or the public SQL Playground)
2424

25-
### 1. Connect to ClickHouse
26-
27-
**ClickHouse Cloud (recommended):**
25+
### 1. Enable MCP on Your Service
2826

2927
1. Log in to your [ClickHouse Cloud console](https://clickhouse.com/cloud)
3028
2. Select your service → click **Connect** → enable **Remote MCP Server**
3129

32-
**Self-hosted ClickHouse:**
33-
34-
You'll need [uv](https://docs.astral.sh/uv/getting-started/installation/) installed, and your ClickHouse host credentials ready.
35-
36-
**Just want to try it out?** The public SQL Playground works with no credentials — see the [Configuration](#configuration) section.
30+
> Self-hosted ClickHouse and the public [SQL Playground](https://sql.clickhouse.com) are also supported via the open-source [`mcp-clickhouse`](https://github.com/ClickHouse/mcp-clickhouse) package. See `POWER.md` for configuration details.
3731
3832
### 2. Install the Power
3933

@@ -43,9 +37,7 @@ Open Kiro and install the **ClickHouse Database** power from the Powers panel, o
4337
https://github.com/ClickHouse/clickhouse-kiro-power
4438
```
4539

46-
For ClickHouse Cloud, the power connects automatically via OAuth — authenticate in your browser when prompted on first use.
47-
48-
For self-hosted ClickHouse or the SQL Playground, see the [Configuration](#configuration) section to update `mcp.json`.
40+
Authenticate via your browser when prompted on first use — no API keys needed.
4941

5042
### 3. Start Querying
5143

@@ -165,60 +157,6 @@ When cloning for development, use `--recurse-submodules` to populate the submodu
165157
git clone --recurse-submodules https://github.com/ClickHouse/clickhouse-kiro-power
166158
```
167159

168-
## Configuration
169-
170-
### ClickHouse Cloud (Default)
171-
172-
No config changes needed — the power ships with `mcp.json` pointing to `https://mcp.clickhouse.cloud/mcp`. Authentication is handled via OAuth on first use.
173-
174-
### Self-Hosted ClickHouse
175-
176-
Replace `mcp.json` with the open-source MCP server:
177-
178-
```json
179-
{
180-
"mcpServers": {
181-
"clickhouse": {
182-
"command": "uv",
183-
"args": ["run", "--with", "mcp-clickhouse", "--python", "3.10", "mcp-clickhouse"],
184-
"env": {
185-
"CLICKHOUSE_HOST": "<your-host>",
186-
"CLICKHOUSE_PORT": "8443",
187-
"CLICKHOUSE_USER": "<your-user>",
188-
"CLICKHOUSE_PASSWORD": "<your-password>",
189-
"CLICKHOUSE_SECURE": "true",
190-
"CLICKHOUSE_VERIFY": "true"
191-
}
192-
}
193-
}
194-
}
195-
```
196-
197-
Requires [uv](https://docs.astral.sh/uv/getting-started/installation/).
198-
199-
### SQL Playground (Try It Out)
200-
201-
No credentials needed — connect to the public ClickHouse SQL Playground:
202-
203-
```json
204-
{
205-
"mcpServers": {
206-
"clickhouse": {
207-
"command": "uv",
208-
"args": ["run", "--with", "mcp-clickhouse", "--python", "3.10", "mcp-clickhouse"],
209-
"env": {
210-
"CLICKHOUSE_HOST": "sql-clickhouse.clickhouse.com",
211-
"CLICKHOUSE_PORT": "8443",
212-
"CLICKHOUSE_USER": "demo",
213-
"CLICKHOUSE_PASSWORD": "",
214-
"CLICKHOUSE_SECURE": "true",
215-
"CLICKHOUSE_VERIFY": "true"
216-
}
217-
}
218-
}
219-
}
220-
```
221-
222160
## Troubleshooting
223161

224162
| Issue | Solution |

0 commit comments

Comments
 (0)