MCP Feishu Proj

🚀 MCP-飛書項目工具包

MCP-飛書項目工具包是基於飛書項目的Open API構建的MCP（機器人流程自動化）工具包。它能讓開發者藉助MCP協議，快速集成與管理飛書項目功能，提升開發效率。

更多詳細信息請參閱MCP協議文檔。

🚀 快速開始

📦 安裝依賴

使用前請確保安裝了以下依賴：

pip install python-multipart uvicorn

▶️ 運行示例

1. 克隆倉庫
2. 創建並編輯配置文件 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"

3. 啟動服務

uvicorn server:app --reload

更多詳細信息請參閱快速上手指南。

✨ 主要特性

已實現的飛書項目功能

1. 📁 項目空間管理
   • 獲取項目列表
   • 獲取單個項目詳情
   • 創建新項目
   • 更新現有項目
2. 🖥️ 工作區管理
   • 獲取所有工作區
   • 獲取單個工作區詳情
   • 創建新工作區
   • 更新現有工作區
3. 👥 成員管理
   • 獲取所有成員列表
   • 獲取單個成員詳情
   • 添加/刪除成員
4. 🔐 權限管理
   • 獲取權限策略列表
   • 創建新的權限策略
   • 刪除權限策略
   • 更新權限策略
5. 🤖 應用與機器人管理
   • 獲取已安裝的應用列表
   • 安裝新應用
   • 卸載應用
6. 📰 事件訂閱
   • 訂閱項目事件
   • 取消訂閱事件

更多詳細信息請參閱功能文檔。

📚 詳細文檔

MCP協議適配

MCP飛書項目工具包嚴格遵循MCP協議規範，支持以下接口：

• info：獲取工具的基本信息
• execute：執行具體的機器人流程自動化任務
• events：處理事件通知

更多詳細信息請參閱MCP適配文檔。

添加新功能

要添加新的飛書項目API功能，請按照以下步驟操作：

1. 在fsprojclient.py中添加新的API方法
2. 在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部署

參考官方文檔進行部署。

🤝 貢獻指南

提交代碼規範

1. 遵循PEP8編碼規範
2. 提供詳細的提交信息
3. 確保單元測試通過
4. 更新相關文檔

更多詳細信息請參閱貢獻指南。

👨‍💻 項目維護者

• 張三：架構設計與核心開發
• 李四：功能實現與技術支持

📄 許可證

本項目遵循MIT License協議。更多信息請查看LICENSE文件。