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