Skip to content
文档
Chat2DB CLI
MCP 与 Agent 集成

MCP 与 Agent 集成

Chat2DB CLI 可以管理 Chat2DB 桌面 MCP endpoint,并安装 Chat2DB-CLI-Skill,让 Codex、Claude Code 等 AI Agent 通过本机 Chat2DB 读取数据源、查看元数据或执行受控 SQL。

MCP 相关命令会影响本机 Chat2DB 应用和本机端口。开始前先检查状态:

chat2db status --json
chat2db mcp status --edition all --json

启用 MCP

启用 Pro MCP:

chat2db mcp enable --edition pro --json

启用 Local MCP:

chat2db mcp enable --edition local --json

enable 会修改对应 edition 的 MCP 设置,并重新启动应用以等待 /mcp endpoint 可用。

获取 MCP client 配置

chat2db mcp config --edition pro --json

该命令会输出 MCP client 可用的 JSON 配置。配置中可能包含本机 MCP token 或 header,发给他人前必须脱敏。

查看工具

chat2db mcp tools --edition pro --json

常见工具包括:

  • list_all_datasources
  • list_all_databases
  • list_all_schemas
  • list_all_tables
  • get_tables_schema
  • text2sql
  • execute_sql

实际工具列表以 chat2db mcp tools 输出为准。

调用工具

列出数据源:

chat2db mcp call list_all_datasources \
  --args-json '{}' \
  --edition pro \
  --json

执行 SQL:

chat2db mcp call execute_sql \
  --args-json '{"dataSourceId":<data-source-id>,"databaseName":"postgres","schemaName":"public","sql":"select 1","pageSize":100}' \
  --edition pro \
  --json

调用 execute_sql 前请确认数据源、数据库、schema 和 SQL 内容。MCP 工具拿到的是本机 Chat2DB 能访问的数据源,不要把 MCP token 或生成的客户端配置交给不受信任的 Agent。

安装 Chat2DB-CLI-Skill

安装到当前目录:

chat2db skill install

安装到 Codex:

chat2db skill install --client codex --json

安装到 Claude Code:

chat2db skill install --client claude-code --json

更新 Skill:

chat2db skill update --client codex --json

如果覆盖已有 skill,需要确认目标目录和 --force --yes 的影响。

关闭 MCP

chat2db mcp disable --edition pro --json

如果需要停止应用、runtime 和 MCP:

chat2db stop --edition pro --all --json

安全边界

  • MCP token、HTTP header、Authorization 值必须脱敏。
  • Pro 和 Local 可能竞争同一个本机 MCP 端口,遇到 ambiguous 时先运行 chat2db status --json。后续会优化为自动选择本地空闲的非熟知端口。
  • Agent 执行 SQL 前,应限制账号权限并确认数据源环境。
  • 生产库建议使用只读账号给 Agent 查询。

常见问题

MCP endpoint 不可用

chat2db mcp status --edition all --json
chat2db mcp restart --edition pro --json

端口状态 ambiguous

先看 Pro / Local 哪个正在运行:

chat2db status --json

必要时停止不使用的 edition:

chat2db stop --edition local --all --json

Agent 配置后仍然失败

重新生成配置,并确认 token、URL 和 edition 一致:

chat2db mcp config --edition pro --json
chat2db mcp tools --edition pro --json