MCP Feishu Proj

🚀 MCP - Feishu Project Toolkit

The MCP - Feishu Project is an MCP (Robotic Process Automation) toolkit built on the Open API of Feishu Project. It enables developers to quickly integrate and manage the functions of Feishu Project through the MCP protocol.

For more detailed information, please refer to the MCP Protocol Documentation.

🚀 Quick Start

Install Dependencies

Make sure you have installed the following dependencies before use:

pip install python-multipart uvicorn

Run the Example

1. Clone the repository.
2. Create and edit the configuration file config.yaml:

version: '3.0'

tools:
  - id: "ff1f4b"
    name: "Feishu Project"
    description: "MCP tool for Feishu Project"
    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. Start the service:

uvicorn server:app --reload

For more detailed information, please refer to the Quick Start Guide.

✨ Features

Implemented Feishu Project Functions

1. Project Space Management

   • Get the project list.
   • Get the details of a single project.
   • Create a new project.
   • Update an existing project.

2. Workspace Management

   • Get all workspaces.
   • Get the details of a single workspace.
   • Create a new workspace.
   • Update an existing workspace.

3. Member Management

   • Get the list of all members.
   • Get the details of a single member.
   • Add/remove members.

4. Permission Management

   • Get the list of permission policies.
   • Create a new permission policy.
   • Delete a permission policy.
   • Update a permission policy.

5. App and Bot Management

   • Get the list of installed apps.
   • Install a new app.
   • Uninstall an app.

6. Event Subscription

   • Subscribe to project events.
   • Unsubscribe from events.

For more detailed information, please refer to the Feature Documentation.

💻 Usage Examples

MCP Protocol Adaptation

The MCP Feishu Project Toolkit strictly follows the MCP Protocol Specification and supports the following interfaces:

• info: Get the basic information of the tool.
• execute: Execute specific robotic process automation tasks.
• events: Handle event notifications.

For more detailed information, please refer to the MCP Adaptation Documentation.

Adding New Features

To add new Feishu Project API features, follow these steps:

1. Add new API methods in fsprojclient.py.
2. Register new MCP tools using the @mcp.tool decorator in server.py.

For more detailed information, please refer to the Development Documentation.

📚 Documentation

• Quick Start Guide: quickstart.md
• Feature List: features.md
• MCP Adaptation Documentation: mcp-adapter.md
• Development Guide: development.md
• Docker Deployment Documentation: docker/docker-README.md
• Kubernetes Deployment Documentation: k8s/k8s-README.md

📦 Configuration

Configuration File Example

version: '3.0'

tools:
  - id: "ff1f4b"
    name: "Feishu Project"
    description: "MCP tool for Feishu Project"
    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"

Environment Variable Configuration

You can override the default configuration by setting the following environment variables:

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"

Example Commands

Get Project Information

curl http://localhost:8000/api/mcp/v1/tools/ff1f4b/info

Execute a Task

curl -X POST http://localhost:8000/api/mcp/v1/tools/ff1f4b/execute \
  -H "Content-Type: application/json" \
  -d '{"tasks": [{"command": "get_projects"}]}'

🚀 Deployment Guide

Docker Deployment

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 Deployment

Refer to the Official Documentation for deployment.

🤝 Contribution Guide

Code Submission Specifications

1. Follow the PEP8 coding standard.
2. Provide detailed commit messages.
3. Ensure that unit tests pass.
4. Update relevant documentation.

For more detailed information, please refer to the Contribution Guide.

🧑‍💻 Project Maintainers

• Zhang San: Architecture design and core development.
• Li Si: Function implementation and technical support.

📄 License

This project is licensed under the MIT License. For more information, please see the LICENSE file.