How to add APISIX MCP Server to Windsurf

Manage Apache APISIX gateway resources through natural language via the Admin API. Paste the config into ~/.codeium/windsurf/mcp_config.json and restart Windsurf.

Last updated June 14, 2026 · 38★ · stdio · apikey

Windsurf config for APISIX MCP Server

npx -y @smithery/cli install @api7/apisix-mcp --client claude

{
  "mcpServers": {
    "apisix-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "apisix-mcp"
      ],
      "env": {
        "APISIX_SERVER_HOST": "your-apisix-server-host",
        "APISIX_SERVER_PORT": "your-apisix-server-port",
        "APISIX_ADMIN_API_PORT": "your-apisix-admin-api-port",
        "APISIX_ADMIN_API_PREFIX": "your-apisix-admin-api-prefix",
        "APISIX_ADMIN_KEY": "your-apisix-api-key"
      }
    }
  }
}

Setup steps

1Open Windsurf → Cascade → the hammer/MCP icon → Configure (or edit ~/.codeium/windsurf/mcp_config.json).
2Paste the APISIX MCP Server config below.
3Fill in placeholder secrets, then save.
4Click Refresh in the MCP panel.
5APISIX MCP Server's tools become available to Cascade.

Before you start

A running Apache APISIX instance (see the APISIX Getting Started guide)
APISIX Admin API key (APISIX_ADMIN_KEY)
Node.js with npx (or pnpm if building from source)

What APISIX MCP Server can do in Windsurf

get_resource

Retrieve resources by type (routes, services, upstreams, etc.).

delete_resource

Remove resources by ID.

send_request_to_gateway

Send a request or multiple requests to the APISIX gateway.

create_route / update_route / delete_route

Manage routes.

create_service / update_service / delete_service

Manage services.

create_upstream / update_upstream / delete_upstream

Manage upstreams.

create_ssl / update_ssl / delete_ssl

Manage SSL certificates.

create_or_update_proto

Manage protobuf definitions.

Security

Requires the APISIX Admin API key (APISIX_ADMIN_KEY). The default key shown in the docs (edd1c9f034335f136f87ad84b625c8f1) is APISIX's well-known default and must be changed in any real deployment. The server has full read/write access to your APISIX gateway configuration, so treat the admin key as a sensitive secret and restrict network access to the Admin API.

APISIX MCP Server + Windsurf FAQ

Where is the Windsurf config file?

Windsurf reads MCP servers from ~/.codeium/windsurf/mcp_config.json. Paste the APISIX MCP Server config there under the "mcpServers" key and restart the client.

Is APISIX MCP Server safe to use with Windsurf?

How do I install it for Claude Desktop?

Run `npx -y @smithery/cli install @api7/apisix-mcp --client claude` to install automatically via Smithery, or add the apisix-mcp mcpServers block manually to your client config.

What environment variables are required?

APISIX_SERVER_HOST (default http://127.0.0.1), APISIX_SERVER_PORT (9080), APISIX_ADMIN_API_PORT (9180), APISIX_ADMIN_API_PREFIX (/apisix/admin), and APISIX_ADMIN_KEY (the Admin API authentication key).

Do I need a running APISIX instance?

Yes. Follow the APISIX Getting Started guide to set up and run APISIX before configuring the MCP server, and ensure your machine can reach the APISIX Admin API.

View repo Full APISIX MCP Server page