Windsurf MCP Integration

🚀 風帆主控程序（MCP）服務器

風帆主控程序（MCP）服務器旨在擴展風帆（Windsurf）IDE 的功能，為其提供一系列額外工具，這些工具是 WindSurf 本身所不具備的。該服務器基於 FastAPI 構建，打造了一個高性能且易於使用的 API 服務器，同時支持 WebSocket，能夠與 WindSurf 實現即時通信。

🚀 快速開始

安裝步驟

1. 克隆倉庫
2. 創建虛擬環境：

   python -m venv venv
   source venv/bin/activate  # 在 Windows 系統中使用：venv\Scripts\activate
   

3. 安裝依賴項：

   pip install -r requirements.txt
   

啟動與使用

1. 啟動 MCP 服務器：

   python main.py
   

   此命令將啟動服務器，監聽地址為 http://localhost:8089

2. 將 WindSurf 配置連接到 MCP 服務器，設置 WebSocket 連接地址為：

   ws://localhost:8089/ws
   

3. 訪問 API 文檔頁面：http://localhost:8089/docs

✨ 主要特性

• FastAPI 後端：高績效、易用性框架
• WebSocket 支持：即時雙向通信
• 可擴展工具系統：輕鬆添加新工具以擴展 WindSurf
• RESTful API：用於工具執行的 HTTP 端點
• WindSurf 整合：與 WindSurf IDE 的無縫整合

📦 安裝指南

1. 克隆倉庫
2. 創建虛擬環境：

   python -m venv venv
   source venv/bin/activate  # 在 Windows 系統中使用：venv\Scripts\activate
   

3. 安裝依賴項：

   pip install -r requirements.txt
   

💻 使用示例

基礎用法

啟動 MCP 服務器：

python main.py

此命令將啟動服務器，監聽地址為 http://localhost:8089

將 WindSurf 配置連接到 MCP 服務器，設置 WebSocket 連接地址為：

ws://localhost:8089/ws

訪問 API 文檔頁面：http://localhost:8089/docs

高級用法

添加自定義工具： 要在 MCP 服務器上添加新的工具：

1. 打開 tools.py 文件
2. 使用 @register_tool 裝飾器註冊你的新工具：

@register_tool(
    name="my_custom_tool",
    description="描述該工具的功能",
    parameters={
        "param1": {"type": "字符串", "description": "參數 1 的描述"},
        "param2": {"type": "整數", "description": "參數 2 的描述"}
    }
)
async def my_custom_tool_handler(params: Dict[str, Any]) -> Any:
    # 工具實現代碼
    param1 = params.get("param1", "")
    param2 = params.get("param2", 0)
    
    # 對參數進行處理
    result = f"已處理 {param1}，其值為 {param2}"
    
    return {"output": result}

📚 詳細文檔

項目結構

MCP_servers/
├── main.py                 # 主 FastAPI 應用程序文件
├── tools.py                # 自定義工具實現文件
├── windsurf_integration.py # WindSurf 集成模塊
├── requirements.txt        # 項目依賴管理文件
└── README.md               # 文檔說明文件

內置工具

MCP 服務器附帶了幾個內置工具：

1. 文件搜索：在指定目錄中按模式查找文件
2. 代碼分析：分析代碼文件的語法、複雜性和依賴性
3. 網絡請求：向外部 API 發送 HTTP 請求

API 端點

• GET /：獲取服務器信息
• GET /tools：列出所有可用工具
• POST /tools/{tool_name}：執行指定工具
• WebSocket /ws：用於即時通信的 WebSocket 端點

📄 許可證

MIT