Windsurf MCP Integration

🚀 Windsurf Master Control Program (MCP) Server

The MCP Server extends the functionality of the Windsurf IDE by offering additional tools not included in Windsurf itself. It uses FastAPI to create a high - performance, user - friendly API server with WebSocket support for real - time communication with WindSurf.

🚀 Quick Start

1. Start the MCP Server:

   python main.py
   

   This command will start the server, listening at http://localhost:8089.

2. Configure WindSurf to connect to the MCP Server: Set the WebSocket connection address to:

   ws://localhost:8089/ws
   

3. Access the API documentation page: http://localhost:8089/docs

✨ Features

• FastAPI Backend: A high - performance and user - friendly framework.
• WebSocket Support: Real - time two - way communication.
• Scalable Tool System: Easily add new tools to extend WindSurf.
• RESTful API: HTTP endpoints for tool execution.
• WindSurf Integration: Seamless integration with the WindSurf IDE.

📦 Installation

1. Clone the repository.
2. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # Use 'venv\Scripts\activate' on Windows
   

3. Install the dependencies:

   pip install -r requirements.txt
   

💻 Usage Examples

Basic Usage

To start the server, run the following command:

python main.py

Advanced Usage

To add a custom tool, follow these steps:

1. Open the tools.py file.
2. Register your new tool using the @register_tool decorator:

@register_tool(
    name="my_custom_tool",
    description="Describe the functionality of the tool",
    parameters={
        "param1": {"type": "string", "description": "Description of parameter 1"},
        "param2": {"type": "integer", "description": "Description of parameter 2"}
    }
)
async def my_custom_tool_handler(params: Dict[str, Any]) -> Any:
    # Tool implementation code
    param1 = params.get("param1", "")
    param2 = params.get("param2", 0)
    
    # Process the parameters
    result = f"Processed {param1} with value {param2}"
    
    return {"output": result}

📚 Documentation

Project Structure

MCP_servers/
├── main.py                 # Main FastAPI application file
├── tools.py                # Custom tool implementation file
├── windsurf_integration.py # WindSurf integration module
├── requirements.txt        # Project dependency management file
└── README.md               # Documentation file

Built - in Tools

The MCP server comes with several built - in tools:

1. File Search: Find files by pattern in a specified directory.
2. Code Analysis: Analyze the syntax, complexity, and dependencies of code files.
3. Network Request: Send HTTP requests to external APIs.

API Endpoints

• GET /: Get server information.
• GET /tools: List all available tools.
• POST /tools/{tool_name}: Execute a specified tool.
• WebSocket /ws: WebSocket endpoint for real - time communication.

📄 License

This project is licensed under the MIT license.