如何使用 ClickHouse MCP server 构建 SlackBot agent

在本指南中，您将学习如何构建一个 SlackBot agent。这个机器人允许您在 Slack 中使用自然语言直接查询您的 ClickHouse 数据。它基于 ClickHouse MCP server 和 PydanticAI。

示例项目

此示例的代码可以在 examples 仓库中找到。

前置条件

您需要先安装 uv
您需要能够访问 Slack 工作区
您需要一个 Anthropic API 密钥，或来自其他 LLM provider 的 API 密钥

创建 Slack 应用

前往 slack.com/apps 并点击 Create New App。
选择 From scratch 选项，并为您的应用命名。
选择您的 Slack 工作区。

将应用安装到您的工作区

接下来，您需要将上一步创建的应用添加到您的工作区。您可以按照 Slack 文档中关于"将应用添加到您的 Slack 工作区"的说明进行操作。

配置 Slack 应用设置

前往 App Home
- 在 Show Tabs → Messages Tab 中，启用 Allow users to send Slash commands and messages from the messages tab
- 前往 Socket Mode
  - 启用 Socket Mode
  - 记下 Socket Mode Handler，用于环境变量 SLACK_APP_TOKEN
- 前往 OAuth & Permissions
  - 添加以下 Bot Token Scopes：
    - app_mentions:read
    - assistant:write
    - chat:write
    - im:history
    - im:read
    - im:write
    - channels:history
  - 将应用安装到工作区，并记下 Bot User OAuth Token，用于环境变量 SLACK_BOT_TOKEN。
- 前往 Event Subscriptions
  - 启用 Events
  - 在 Subscribe to bot events 中添加：
    - app_mention
    - assistant_thread_started
    - message:im
  - 保存更改

添加环境变量 (`.env`)

在项目根目录中创建一个 .env 文件，并添加以下环境变量，这样您的应用即可连接到 ClickHouse 的 SQL playground。

SLACK_BOT_TOKEN=your-slack-bot-token
SLACK_APP_TOKEN=your-slack-app-level-token
ANTHROPIC_API_KEY=your-anthropic-api-key
CLICKHOUSE_HOST=sql-clickhouse.clickhouse.com
CLICKHOUSE_PORT=8443
CLICKHOUSE_USER=demo
CLICKHOUSE_PASSWORD=
CLICKHOUSE_SECURE=true

如果您愿意，也可以调整这些 ClickHouse 变量，改为使用您自己的 ClickHouse server 或 Cloud instance。

使用机器人

启动机器人：
```
uv run main.py
```
在 Slack 中：
- 在频道中提及机器人：@yourbot Who are the top contributors to the ClickHouse git repo?
- 在线程中回复并提及机器人：@yourbot how many contributions did these users make last week?
- 向机器人发送私信：Show me all tables in the demo database.

机器人会在线程中回复，并在适用时将该线程中之前的所有消息用作上下文。

线程上下文： 在线程中回复时，机器人会加载之前的所有消息 (当前消息除外) ，并将其作为 AI 的上下文。

工具使用： 机器人仅使用通过 MCP 提供的工具 (例如 schema 发现、SQL 执行) ，并始终展示所使用的 SQL 以及答案得出的摘要。

前置条件​

创建 Slack 应用​

将应用安装到您的工作区​

配置 Slack 应用设置​

添加环境变量 (.env)​

使用机器人​