How to Use the Apache APISIX MCP in Windsurf

Q: How does the Apache APISIX MCP Server handle validation errors in Windsurf?

Cascade uses getcontrolschema to inspect the rules for your plugins and routes before making updates. If a parameter fails validation, the agent catches the error and corrects the payload before retrying.

Q: Can I safely trigger Lua garbage collection on my gateway using this server?

Yes, the triggercontrolgc tool allows you to clear the HTTP Lua VM memory directly through your agent. This is useful when debugging memory spikes during intense traffic periods.

Let Windsurf autonomously chain your Apache APISIX routing updates and upstream health checks in a single, uninterrupted session.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Apache APISIX MCP to Windsurf

Create your Vinkius account to connect Apache APISIX to Windsurf and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup Apache APISIX with Windsurf

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Autonomous Apache APISIX Routing with Windsurf Cascade

This MCP Server exposes tools like `get_control_healthcheck` and `put_route` so Windsurf can monitor gateway health and rewrite active endpoints. Cascade reads the real-time node failures, decides on a healthy backup, and immediately updates your routing table without prompting you for each intermediate step. You specify the target state, and the agent resolves the dependency chain by fetching schemas with `get_control_schema` before deploying the change. It executes the whole loop in one go, leaving your terminal free.

Hot-Reloading Gateway Plugins

The `reload_control_plugins` and `put_plugin_config` tools let your agent hot-reload configurations directly inside your running cluster. When you tell Cascade to update an authentication policy, it writes the configuration, verifies it against the schema, and triggers the reload. Cascade handles the verification steps behind the scenes, ensuring your gateway never loads a broken payload. You get immediate feedback on whether the new policy passed validation.

Consumer and SSL Lifecycle Management

You can manage access controls using `put_consumer`, `put_consumer_group`, and `put_ssl` directly from your IDE. Cascade uses these tools to provision new API clients, bind them to specific consumer groups, and apply their SSL certificates in sequence. Instead of jumping between Admin API calls, you ask Cascade to onboard a user, and it chains the database writes and certificate applications. It reports back once the entire security profile is active.

Setup guide

Set up Apache APISIX MCP in Windsurf

Prerequisites

Windsurf IDE installed (macOS, Windows, or Linux)
Active Vinkius subscription with a valid endpoint token

1

Open MCP configuration

Click the Cascade assistant icon in the sidebar, then click the hammer icon (🔨) at the top of the panel. Select "Configure" to open ~/.codeium/windsurf/mcp_config.json.
2

Add the Apache APISIX MCP

Paste the JSON snippet shown on the right into the mcpServers object. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com.
3

Refresh MCPs

Go back to the hammer icon (🔨) in Cascade and click "Refresh". Windsurf will detect the new server. No full restart is needed — the connection is hot-reloaded.
4

Verify in Cascade

Start a new Cascade conversation and ask something like "Show my Apache APISIX payment history." If connected, Cascade will call the Apache APISIX tools directly. You will see a green dot next to the server name in the MCP panel.

mcp_config.json

{
  "mcpServers": {
    "apache-apisix-mcp": {
      "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    }
  }
}

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Apache APISIX. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Apache APISIX now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Apache APISIX MCP in Windsurf

Open your global settings, find the Cascade configuration, and add the server endpoint under the `mcpServers` key. Once you click refresh, Windsurf auto-discovers all fifty gateway management tools.

Yes, Cascade analyzes the dependencies between your gateway resources. It will call `put_upstream` to establish your backend nodes before it executes `put_route` to direct traffic there.

Cascade uses `get_control_schema` to inspect the rules for your plugins and routes before making updates. If a parameter fails validation, the agent catches the error and corrects the payload before retrying.

Yes, the `trigger_control_gc` tool allows you to clear the HTTP Lua VM memory directly through your agent. This is useful when debugging memory spikes during intense traffic periods.

Your sensitive credentials and SSL private keys never leave the Vinkius MCP Server sandbox. Windsurf communicates with the server via encrypted endpoints, meaning your gateway admin tokens are never exposed to the LLM provider.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript