mcp-clickhouse/server.json at main · ClickHouse/mcp-clickhouse · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
{
  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
  "name": "io.github.ClickHouse/mcp-clickhouse",
  "title": "ClickHouse",
  "description": "Official ClickHouse MCP server for querying and exploring ClickHouse clusters and chDB.",
  "version": "0.6.0",
  "repository": {
    "url": "https://github.com/ClickHouse/mcp-clickhouse",
    "source": "github"
  },
  "websiteUrl": "https://clickhouse.com",
  "packages": [
    {
      "registryType": "pypi",
      "identifier": "mcp-clickhouse",
      "version": "0.6.0",
      "runtimeHint": "uvx",
      "transport": {
        "type": "stdio"
      },
      "environmentVariables": [
        {
          "name": "CLICKHOUSE_HOST",
          "description": "Hostname of the ClickHouse server",
          "isRequired": true
        },
        {
          "name": "CLICKHOUSE_USER",
          "description": "Username for ClickHouse authentication",
          "isRequired": true
        },
        {
          "name": "CLICKHOUSE_PASSWORD",
          "description": "Password for ClickHouse authentication. Required unless a client certificate uses the default or mutual TLS mode",
          "isRequired": false,
          "isSecret": true
        },
        {
          "name": "CLICKHOUSE_PORT",
          "description": "ClickHouse HTTP(S) port. Defaults to 8443 when CLICKHOUSE_SECURE=true, 8123 otherwise",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_SECURE",
          "description": "Use HTTPS to connect to ClickHouse",
          "format": "boolean",
          "default": "true",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_VERIFY",
          "description": "Verify SSL certificates",
          "format": "boolean",
          "default": "true",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_CA_CERT",
          "description": "Path to a PEM CA bundle for ClickHouse server certificate verification",
          "format": "filepath",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_CLIENT_CERT",
          "description": "Path to a PEM client certificate for the ClickHouse HTTPS connection",
          "format": "filepath",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_CLIENT_CERT_KEY",
          "description": "Path to the PEM private key for CLICKHOUSE_CLIENT_CERT",
          "format": "filepath",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_TLS_MODE",
          "description": "Client certificate mode: mutual, proxy, or strict",
          "choices": ["mutual", "proxy", "strict"],
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_DATABASE",
          "description": "Default database to use",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_ROLE",
          "description": "ClickHouse role to activate for the session",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_ALLOW_WRITE_ACCESS",
          "description": "Allow write operations (DDL and DML). Queries run read-only by default",
          "format": "boolean",
          "default": "false",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_ALLOW_DROP",
          "description": "Allow destructive operations (DROP, TRUNCATE, DELETE, UPDATE, REPLACE, CLEAR, and DETACH PERMANENTLY) when write access is also enabled",
          "format": "boolean",
          "default": "false",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_MCP_QUERY_TIMEOUT",
          "description": "Query tool timeout in seconds",
          "format": "number",
          "default": "30",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_MCP_MAX_WORKERS",
          "description": "Maximum query worker thread pool size",
          "format": "number",
          "default": "10",
          "isRequired": false
        }
      ]
    },
    {
      "registryType": "oci",
      "identifier": "ghcr.io/clickhouse/mcp-clickhouse:0.6.0",
      "transport": {
        "type": "stdio"
      },
      "environmentVariables": [
        {
          "name": "CLICKHOUSE_HOST",
          "description": "Hostname of the ClickHouse server",
          "isRequired": true
        },
        {
          "name": "CLICKHOUSE_USER",
          "description": "Username for ClickHouse authentication",
          "isRequired": true
        },
        {
          "name": "CLICKHOUSE_PASSWORD",
          "description": "Password for ClickHouse authentication. Required unless a client certificate uses the default or mutual TLS mode",
          "isRequired": false,
          "isSecret": true
        },
        {
          "name": "CLICKHOUSE_PORT",
          "description": "ClickHouse HTTP(S) port. Defaults to 8443 when CLICKHOUSE_SECURE=true, 8123 otherwise",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_SECURE",
          "description": "Use HTTPS to connect to ClickHouse",
          "format": "boolean",
          "default": "true",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_VERIFY",
          "description": "Verify SSL certificates",
          "format": "boolean",
          "default": "true",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_CA_CERT",
          "description": "Path to a PEM CA bundle for ClickHouse server certificate verification",
          "format": "filepath",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_CLIENT_CERT",
          "description": "Path to a PEM client certificate for the ClickHouse HTTPS connection",
          "format": "filepath",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_CLIENT_CERT_KEY",
          "description": "Path to the PEM private key for CLICKHOUSE_CLIENT_CERT",
          "format": "filepath",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_TLS_MODE",
          "description": "Client certificate mode: mutual, proxy, or strict",
          "choices": ["mutual", "proxy", "strict"],
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_DATABASE",
          "description": "Default database to use",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_ROLE",
          "description": "ClickHouse role to activate for the session",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_ALLOW_WRITE_ACCESS",
          "description": "Allow write operations (DDL and DML). Queries run read-only by default",
          "format": "boolean",
          "default": "false",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_ALLOW_DROP",
          "description": "Allow destructive operations (DROP, TRUNCATE, DELETE, UPDATE, REPLACE, CLEAR, and DETACH PERMANENTLY) when write access is also enabled",
          "format": "boolean",
          "default": "false",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_MCP_QUERY_TIMEOUT",
          "description": "Query tool timeout in seconds",
          "format": "number",
          "default": "30",
          "isRequired": false
        },
        {
          "name": "CLICKHOUSE_MCP_MAX_WORKERS",
          "description": "Maximum query worker thread pool size",
          "format": "number",
          "default": "10",
          "isRequired": false
        }
      ]
    }
  ]
}