feishu-automation 是做什么的？
用于飞书文档、附件和 Webhook 通知的 Codex 技能与 MCP 工具
概述
ZLZLGe/feishu-automation 是一个 AI 代理技能，专注于通过 Codex 和 MCP（模型上下文协议）接口与飞书平台进行交互。它提供了一套工具，允许 AI 助手直接操作飞书文档、管理附件以及发送 Webhook 通知，从而帮助用户自动化和简化日常工作流程。
功能特性
- 文档管理：创建、读取、更新和删除飞书文档。支持 Markdown 和纯文本格式。
- 附件处理：上传、下载和管理飞书文档中的附件。
- Webhook 通知：发送自定义消息到飞书群聊的 Webhook 地址。
- AI 原生集成：通过 MCP 协议与 Codex、Claude、Cursor 等 AI 代理无缝集成。
- 安全认证：使用飞书开放平台 OAuth 2.0 认证，确保 API 调用的安全。
安装与配置
前提条件
- 飞书开发者账号和应用（自建应用或商店应用）
- 飞书开放平台 API 权限
- 环境变量配置
环境变量
| 变量名 | 描述 | 必填 |
|---|---|---|
FEISHU_APP_ID | 飞书应用 ID | 是 |
FEISHU_APP_SECRET | 飞书应用密钥 | 是 |
FEISHU_BASE_URL | 飞书 API 基础 URL（默认：https://open.feishu.cn） | 否 |
安装步骤
- 克隆项目仓库：
git clone https://github.com/ZLZLGe/feishu-automation.git
cd feishu-automation
- 安装依赖：
npm install
# 或
pnpm install
-
配置环境变量：创建
.env文件并填写飞书应用凭据。 -
启动服务：
npm start
使用指南
作为 Codex 技能
在 Codex 配置中添加该技能路径，即可通过对话方式调用飞书功能。
作为 MCP 工具
如果使用的是支持 MCP 协议的 AI 代理（如 Claude、Cursor），可以在其配置文件中引用该工具的路径。
示例 MCP 配置（mcp.json）
{
"mcpServers": {
"feishu-automation": {
"command": "node",
"args": ["path/to/server.js"],
"env": {
"FEISHU_APP_ID": "${FEISHU_APP_ID}",
"FEISHU_APP_SECRET": "${FEISHU_APP_SECRET}"
}
}
}
}
可用工具
| 工具名称 | 描述 |
|---|---|
create_document | 创建新的飞书文档 |
update_document | 更新现有飞书文档内容 |
get_document | 获取飞书文档内容 |
delete_document | 删除飞书文档 |
upload_attachment | 上传附件到飞书文档 |
download_attachment | 从飞书文档下载附件 |
send_webhook | 发送消息到 Webhook 地址 |
开发
本地开发
npm run dev
测试
npm test
贡献
欢迎通过 Issue 和 Pull Request 贡献代码。
许可证
MIT