🚀 MCP-飞书项目工具包
MCP-飞书项目工具包是基于飞书项目的Open API构建的MCP（机器人流程自动化）工具包。它能让开发者借助MCP协议，快速集成并管理飞书项目的各项功能。
更多详细信息请参阅MCP协议文档。
🚀 快速开始
📦 安装依赖
使用前请确保安装了以下依赖：
pip install python-multipart uvicorn
▶️ 运行示例
- 克隆仓库。
- 创建并编辑配置文件
config.yaml：
version: '3.0'
tools:
- id: "ff1f4b"
name: "飞书项目"
description: "飞书项目的MCP工具"
type: "FS_PROJECT"
config:
base_url: "https://project.feishu.cn/"
project_key: "your_project_key"
user_key: "your_user_key"
plugin_id: "your_plugin_id"
plugin_secret: "your_plugin_secret"
- 启动服务：
uvicorn server:app --reload
更多详细信息请参阅快速上手指南。
✨ 主要特性
已实现的飞书项目功能
- 📁 项目空间管理
- 获取项目列表
- 获取单个项目详情
- 创建新项目
- 更新现有项目
- 🖥️ 工作区管理
- 获取所有工作区
- 获取单个工作区详情
- 创建新工作区
- 更新现有工作区
- 👥 成员管理
- 获取所有成员列表
- 获取单个成员详情
- 添加/删除成员
- 🔐 权限管理
- 获取权限策略列表
- 创建新的权限策略
- 删除权限策略
- 更新权限策略
- 📱 应用与机器人管理
- 获取已安装的应用列表
- 安装新应用
- 卸载应用
- 📢 事件订阅
- 订阅项目事件
- 取消订阅事件
更多详细信息请参阅功能文档。
📚 详细文档
MCP协议适配
MCP飞书项目工具包严格遵循MCP协议规范，支持以下接口：
info：获取工具的基本信息execute：执行具体的机器人流程自动化任务events：处理事件通知
更多详细信息请参阅MCP适配文档。
添加新功能
要添加新的飞书项目API功能，请按照以下步骤操作：
- 在
fsprojclient.py中添加新的API方法。 - 在
server.py中使用@mcp.tool装饰器注册新的MCP工具。
更多详细信息请参阅开发文档。
📦 安装指南
配置文件示例
version: '3.0'
tools:
- id: "ff1f4b"
name: "飞书项目"
description: "飞书项目的MCP工具"
type: "FS_PROJECT"
config:
base_url: "https://project.feishu.cn/"
project_key: "your_project_key"
user_key: "your_user_key"
plugin_id: "your_plugin_id"
plugin_secret: "your_plugin_secret"
环境变量配置
可以通过设置以下环境变量来覆盖默认配置：
MCP_BASE_URL="https://project.feishu.cn/"
MCP_PROJECT_KEY="your_project_key"
MCP_USER_KEY="your_user_key"
MCP_PLUGIN_ID="your_plugin_id"
MCP_PLUGIN_SECRET="your_plugin_secret"
💻 使用示例
基础用法
获取项目信息
curl http://localhost:8000/api/mcp/v1/tools/ff1f4b/info
执行任务
curl -X POST http://localhost:8000/api/mcp/v1/tools/ff1f4b/execute \
-H "Content-Type: application/json" \
-d '{"tasks": [{"command": "get_projects"}]}'
🚀 部署指南
Docker部署
FROM python:3.9-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY . .
CMD ["uvicorn", "server:app"]
Kubernetes部署
参考官方文档进行部署。
🤝 贡献指南
提交代码规范
- 遵循PEP8编码规范。
- 提供详细的提交信息。
- 确保单元测试通过。
- 更新相关文档。
更多详细信息请参阅贡献指南。
👨💻 项目维护者
- 张三：架构设计与核心开发
- 李四：功能实现与技术支持
📄 许可证
本项目遵循MIT License协议。更多信息请查看LICENSE文件。