Skip to content

Commit eedefba

Browse files
BohuTANGBohuTANG
committed
docs: refine MCP Client Integration documentation
- Add comprehensive MCP integration guide with support for Codex, Claude Code, Cursor, Claude Desktop, VS Code - Include Databend Cloud connection instructions with DSN examples - Add Available Tools section (database, stage, connection operations) - Add Configuration table with SAFE_MODE and query timeout options - Shorten sidebar titles to prevent line wrap - Improve Chinese translations for natural flow
1 parent 10a1f5d commit eedefba

File tree

6 files changed

+379
-5
lines changed

6 files changed

+379
-5
lines changed

‎docs/cn/guides/51-ai-functions/01-external-functions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: 集成自定义 AI 模型
2+
title: AI 自定义函数
33
---
44

5-
# 集成自定义 AI 模型
5+
# AI 自定义函数
66

77
通过将 Databend 与您自己的基础设施连接，构建强大的 AI/ML 能力。外部函数（External Functions）允许您部署自定义模型、利用 GPU 加速，并与任何 ML 框架集成，同时确保数据安全。
88

‎docs/cn/guides/51-ai-functions/03-mcp-integration.md‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
---
2+
title: MCP Client 集成
3+
---
4+
5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
7+
8+
# MCP Client 集成
9+
10+
## 概览
11+
12+
[Databend MCP](https://github.com/databendlabs/mcp-databend) 基于 Model Context Protocol 协议，将 Databend 的数据能力无缝集成到您的 AI 助手工作流中。支持 Claude Code、Codex、Cursor、Claude Desktop、VS Code 等主流 MCP 客户端。
13+
14+
**核心能力：**
15+
- **智能 SQL 生成**：根据业务需求自动生成复杂的 SQL 查询。
16+
- **自动化运维**：直接创建和管理定时数据管道任务。
17+
- **交互式探索**：即时查看数据库 Schema 结构并校验查询语法。
18+
- **ETL 工作流**：流畅执行 COPY、MERGE 和 Stage 文件操作。
19+
20+
例如：*"创建一个定时任务，每分钟从 @my_stage 复制 parquet 文件到 orders 表，并验证任务是否正常运行。"*
21+
22+
## 安装
23+
24+
### 1. 获取连接信息
25+
26+
推荐使用 **Databend Cloud** 以获得开箱即用的体验。
27+
28+
1. 登录 [Databend Cloud](https://app.databend.cn)。
29+
2. 点击 **链接（DSN）**。
30+
3. 获取常规连接信息（Host, User, Password 等）。
31+
4. 复制完整 DSN，格式如下：
32+
`databend://user:pwd@host:443/database?warehouse=warehouse_name`
33+
34+
### 2. 配置 MCP 客户端
35+
36+
<Tabs groupId="mcp-clients">
37+
38+
<TabItem value="codex" label="Codex">
39+
40+
```bash
41+
codex mcp add databend -- -e DATABEND_DSN="databend://user:password@host:port/database?warehouse=your_warehouse" -e SAFE_MODE=false -- uv tool run mcp-databend
42+
```
43+
44+
或添加到 `~/.codex/config.toml`:
45+
46+
```toml
47+
[mcp_servers.databend]
48+
command = "uv"
49+
args = ["tool", "run", "mcp-databend"]
50+
51+
[mcp_servers.databend.env]
52+
DATABEND_DSN = "databend://user:password@host:port/database?warehouse=your_warehouse"
53+
SAFE_MODE = "false"
54+
```
55+
56+
</TabItem>
57+
58+
<TabItem value="claude-code" label="Claude Code">
59+
60+
```bash
61+
claude mcp add databend -e DATABEND_DSN="databend://user:password@host:port/database?warehouse=your_warehouse" -e SAFE_MODE=false -- uv tool run mcp-databend
62+
```
63+
64+
</TabItem>
65+
66+
<TabItem value="cursor" label="Cursor">
67+
68+
添加到 `~/.cursor/mcp.json`:
69+
70+
```json
71+
{
72+
"mcpServers": {
73+
"databend": {
74+
"command": "uv",
75+
"args": ["tool", "run", "mcp-databend"],
76+
"env": {
77+
"DATABEND_DSN": "databend://user:password@host:port/database?warehouse=your_warehouse",
78+
"SAFE_MODE": "false"
79+
}
80+
}
81+
}
82+
}
83+
```
84+
85+
</TabItem>
86+
87+
<TabItem value="claude-desktop" label="Claude Desktop">
88+
89+
添加到 `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) 或 `%APPDATA%/Claude/claude_desktop_config.json` (Windows):
90+
91+
```json
92+
{
93+
"mcpServers": {
94+
"databend": {
95+
"command": "uv",
96+
"args": ["tool", "run", "mcp-databend"],
97+
"env": {
98+
"DATABEND_DSN": "databend://user:password@host:port/database?warehouse=your_warehouse",
99+
"SAFE_MODE": "false"
100+
}
101+
}
102+
}
103+
}
104+
```
105+
106+
</TabItem>
107+
108+
<TabItem value="vscode" label="VS Code">
109+
110+
添加到 `.vscode/mcp.json`:
111+
112+
```json
113+
{
114+
"mcpServers": {
115+
"databend": {
116+
"command": "uv",
117+
"args": ["tool", "run", "mcp-databend"],
118+
"env": {
119+
"DATABEND_DSN": "databend://user:password@host:port/database?warehouse=your_warehouse",
120+
"SAFE_MODE": "false"
121+
}
122+
}
123+
}
124+
}
125+
```
126+
127+
</TabItem>
128+
129+
<TabItem value="manual" label="Manual">
130+
131+
```bash
132+
export DATABEND_DSN="databend://user:password@host:port/database?warehouse=your_warehouse"
133+
export SAFE_MODE="false"
134+
135+
uv tool run mcp-databend
136+
```
137+
138+
</TabItem>
139+
140+
</Tabs>
141+
142+
### 3. 连接测试
143+
144+
```bash
145+
# Claude Code 用户
146+
claude mcp list
147+
148+
# Codex 用户
149+
codex mcp list
150+
```
151+
152+
## 功能列表
153+
154+
### 数据库操作
155+
156+
| 工具 | 说明 |
157+
|------|------|
158+
| `execute_sql` | 执行 SQL (含超时保护) |
159+
| `show_databases` | 查看所有数据库 |
160+
| `show_tables` | 查看表列表 (支持模糊搜索) |
161+
| `describe_table` | 查看表结构信息 |
162+
163+
### Stage 管理
164+
165+
| 工具 | 说明 |
166+
|------|------|
167+
| `show_stages` | 查看所有 Stage |
168+
| `list_stage_files` | 列出 Stage 文件 |
169+
| `create_stage` | 创建 Stage (支持 Connection) |
170+
171+
### 连接管理
172+
173+
| 工具 | 说明 |
174+
|------|------|
175+
| `show_connections` | 查看可用连接 |
176+
177+
## 参数配置
178+
179+
| 变量 | 说明 | 默认值 |
180+
|------|------|--------|
181+
| `DATABEND_DSN` | 连接字符串 (DSN) | 必填 |
182+
| `SAFE_MODE` | 安全模式 (禁止 DROP/DELETE 等高危操作) | `true` |
183+
| `DATABEND_QUERY_TIMEOUT` | 查询超时 (秒) | `300` |
184+
185+
更多关于构建对话式 BI 工具的内容，请参阅 [MCP Server 指南](02-mcp.md)。

‎docs/cn/guides/51-ai-functions/index.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,6 @@ MCP（Model Context Protocol）服务器让 AI 助手能够用自然语言查询
2828

2929
**[外部函数指南](01-external-functions.md)** —— 通过示例学习如何创建和部署自定义 AI 函数
3030

31-
**[MCP 服务器指南](02-mcp.md)** —— 使用 mcp-databend 构建自然语言驱动的 BI 工具
31+
**[MCP 服务器指南](02-mcp.md)** —— 使用 mcp-databend 构建自然语言驱动的 BI 工具
32+
33+
**[MCP Client 集成](03-mcp-integration.md)** —— 配置通用 MCP 客户端（如 Codex）连接 Databend

‎docs/en/guides/51-ai-functions/01-external-functions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Custom AI/ML with External Functions
2+
title: External AI Functions
33
---
44

5-
# Custom AI/ML with External Functions
5+
# External AI Functions
66

77
Build powerful AI/ML capabilities by connecting Databend with your own infrastructure. External functions let you deploy custom models, leverage GPU acceleration, and integrate with any ML framework while keeping your data secure.
88

0 commit comments

Comments
 (0)