Windsurf gRPC API

v1.0.0Developer Toolsstable

逆向 Windsurf IDE 的完整后端协议,封装成 Python SDK。 从 Language Server 二进制文件中提取了 13 个 gRPC 服务、560+ 个 RPC 方法, 涵盖用户管理、AI 模型调用、聊天补全、团队计费、MCP 插件、实验注入等全部功能。 基于 Connect-protocol(gRPC over HTTP/1.1 + JSON),零依赖,三行代码上手。

windsurf-grpc-apimcpai-integration
Share:
58
Stars
0
Downloads
0
Weekly
0/5

What is Windsurf gRPC API?

Windsurf gRPC API is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to 逆向 windsurf ide 的完整后端协议,封装成 python sdk。 从 language server 二进制文件中提取了 13 个 grpc 服务、560+ 个 rpc 方法, 涵盖用户管理、ai 模型调用、聊天补全、团队计费、mcp 插件、实验注入等全部功能。 基于 connect-protocol(grpc over http/1.1 + json),零依赖,三行代码上手。

逆向 Windsurf IDE 的完整后端协议,封装成 Python SDK。 从 Language Server 二进制文件中提取了 13 个 gRPC 服务、560+ 个 RPC 方法, 涵盖用户管理、AI 模型调用、聊天补全、团队计费、MCP 插件、实验注入等全部功能。 基于 Connect-protocol(gRPC over HTTP/1.1 + JSON),零依赖,三行代码上手。

This server falls under the Developer Tools category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • 逆向 Windsurf IDE 的完整后端协议,封装成 Python SDK。 从 Language Server 二进

Use Cases

Access Windsurf IDE backend services including AI model integration.
Execute gRPC methods for user management, team billing, and AI features.
fendoushaonian

Maintainer

LicenseMIT
Languagerust
Versionv1.0.0
UpdatedMay 21, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

Manual Installation

npx windsurf-grpc-api

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use Windsurf gRPC API

The WindSurf gRPC API project reverse-engineers the Windsurf IDE's complete backend protocol and packages it as a Python SDK, exposing 13 gRPC services and 567+ RPC methods covering user management, AI model invocation, chat completions, team billing, MCP plugin control, and feature flag injection. It also ships a multi-protocol proxy server that translates the Windsurf protocol into OpenAI, Anthropic, and Gemini compatible endpoints. Developers use it to programmatically access Windsurf's AI capabilities, automate account operations, or front the Windsurf backend with a standard LLM API interface.

Prerequisites

  • Python 3.10 or later installed
  • A valid Windsurf API key in the format sk-ws-xxxxxxx (obtained from the Windsurf IDE)
  • Git to clone the repository (no PyPI package available; install from source)
  • An MCP-compatible client if using the MCP integration
1

Clone the repository

The WindSurf gRPC API is installed from source. Clone the GitHub repository to your local machine.

git clone https://github.com/fendoushaonian/WindSurf-gRPC-API.git
cd WindSurf-gRPC-API
2

Install the package

Install in editable mode so the windsurf_api module and its CLI entry points are available system-wide. Alternatively, copy the windsurf_api/ directory into your project.

pip install -e .
3

Verify your Windsurf API key

Test connectivity with a quick status check using your sk-ws-xxxxxxx key before setting up the proxy or MCP server.

python -c "from windsurf_api import WindsurfClient; ws = WindsurfClient(api_key='sk-ws-your-key'); print(ws.get_user_status())"
4

Start the proxy server

The proxy exposes OpenAI/Anthropic/Gemini compatible endpoints on port 8080 (configurable). Pass one or more Windsurf API keys for load balancing.

python -m windsurf_api.proxy --keys sk-ws-key1,sk-ws-key2 --port 8080
5

Configure your MCP client to use the proxy

Point your MCP client at the local proxy. The proxy translates MCP tool calls into Windsurf gRPC calls. Set an auth token with --auth to secure the proxy endpoint.

{
  "mcpServers": {
    "windsurf-grpc": {
      "command": "python",
      "args": ["-m", "windsurf_api.proxy", "--keys", "sk-ws-your-key", "--port", "8080"]
    }
  }
}

Windsurf gRPC API Examples

Client configuration

Example MCP config that launches the WindSurf proxy server as a local subprocess. Replace sk-ws-your-key with your actual Windsurf API key.

{
  "mcpServers": {
    "windsurf-grpc": {
      "command": "python",
      "args": [
        "-m", "windsurf_api.proxy",
        "--keys", "sk-ws-your-key",
        "--port", "8080",
        "--auth", "my-local-secret"
      ]
    }
  }
}

Prompts to try

Example Python SDK usage and proxy interactions for common Windsurf backend operations.

- "Check my Windsurf account status, plan name, and remaining credits"
- "List all AI models available through the Windsurf backend"
- "Start a Cascade AI conversation and ask it to explain my codebase structure"
- "Inject the experiment flag to unlock Pro features for my current session"
- "Retrieve my Windsurf MCP plugin credentials and list installed plugins"
- "Verify the current API endpoint and extract the active gRPC protocol version"

Troubleshooting Windsurf gRPC API

Authentication fails with 'invalid API key' on WindsurfClient initialisation

Windsurf API keys must be in the sk-ws-xxxxxxx format. Obtain your key from the Windsurf IDE's settings or account panel. GitHub, Google, and Microsoft tokens are only used for the OAuth registration flow, not for SDK authentication.

pip install -e . fails with missing dependencies

Ensure you are using Python 3.10+ and that pip is up to date (pip install --upgrade pip). If grpc or protobuf compilation fails, try installing the pre-built wheels: pip install grpcio grpcio-tools protobuf before rerunning the install.

Proxy server returns 401 when called from the MCP client

If you started the proxy with --auth my-secret, all requests must include the Authorization header. Set the same secret in your MCP client config or remove --auth for local-only development where authentication is not needed.

Frequently Asked Questions about Windsurf gRPC API

What is Windsurf gRPC API?

Windsurf gRPC API is a Model Context Protocol (MCP) server that 逆向 windsurf ide 的完整后端协议,封装成 python sdk。 从 language server 二进制文件中提取了 13 个 grpc 服务、560+ 个 rpc 方法, 涵盖用户管理、ai 模型调用、聊天补全、团队计费、mcp 插件、实验注入等全部功能。 基于 connect-protocol(grpc over http/1.1 + json),零依赖,三行代码上手。 It connects AI assistants to external tools and data sources through a standardized interface.

How do I install Windsurf gRPC API?

Follow the installation instructions on the Windsurf gRPC API GitHub repository. Clone the repo, install dependencies, and add the server config to your AI client.

Which AI clients work with Windsurf gRPC API?

Windsurf gRPC API works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is Windsurf gRPC API free to use?

Yes, Windsurf gRPC API is open source and available under the MIT license. You can use it freely in both personal and commercial projects.

Browse More Developer Tools MCP Servers

Explore all developer tools servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "windsurf-grpc-api": { "command": "npx", "args": ["-y", "windsurf-grpc-api"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide →

Ready to use Windsurf gRPC API?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides