在本指南中,你将学习如何构建一个 SlackBot 智能体。 这个机器人让你能够直接在 Slack 中使用自然语言查询 ClickHouse 数据。它使用 ClickHouse MCP 服务器 和 PydanticAI。
前置条件
- 你需要先安装好
uv - 你需要有权访问一个 Slack 工作区
- 你需要一个 Anthropic API key,或其他 LLM 提供商的 API key
创建 Slack App
- 前往 slack.com/apps,然后点击
Create New App。 - 选择
From scratch,并为应用命名。 - 选择你的 Slack 工作区。
将应用安装到工作区
接下来,你需要将上一步创建的应用添加到工作区中。 你可以按照 Slack 文档 "Add apps to your Slack workspace" 中的说明进行操作。
配置 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:readassistant:writechat:writeim:historyim:readim:writechannels:history
- 将应用安装到你的工作区,并记下
Bot User OAuth Token,用于环境变量SLACK_BOT_TOKEN。
- 添加以下
- 前往
Event Subscriptions- 启用
Events - 在
Subscribe to bot events下添加:app_mentionassistant_thread_startedmessage:im
Save Changes
- 启用
- 在
[object Object]
在项目根目录创建一个 .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 实例。
使用机器人
-
启动机器人:
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 以及答案生成方式的摘要。