Skip to main content

MCP Server (Experimental)

The Model Context Protocol (MCP) server provides access to the Ververica Unified Streaming Data Platform. This server enables Large Language Models (LLMs) to interact with Managed Service, Self-Managed, and BYOC deployment options through the creation and management of deployments and SQL scripts.

All MCP traffic is local stdio (vvctl mcp start), so no extra ports are opened.

This feature is currently in an experimental state. You can use it, but Ververica does not recommend using it in production environments.

Key Features​

  • SQL script drafts management.
  • Deployment management for Java, Python, and SQL.
  • Artifact management.
  • Secrets management.
  • Deployment logs for debugging.
  • Script executions.
  • Context management.

Get Started​

To use the MCP server, configure it in your client using the vvctl mcp start command.

Standard config​

This configuration works in most of the clients

{
  "mcpServers": {
    "ververica": {
      "command": "vvctl",
      "args": ["mcp", "start"]
    }
  }
}
Amp

Add the server through the Amp VS Code extension Settings screen or by updating your settings.json file:

"amp.mcpServers": {
  "ververica": {
    "command": "vvctl",
    "args": ["mcp", "start"]
  }
}

Amp CLI Setup

Add the server using the amp mcp add command:

amp mcp add ververica -- vvctl mcp start
Claude Code

Use the Claude Code CLI to add the Ververica MCP server:

claude mcp add ververica vvctl mcp start
Claude Desktop

Follow the MCP installation guide and use the standard configuration provided above.

Cline

Follow the instructions in Configuring MCP Servers.

Example: Local Setup

Add the following to your cline_mcp_settings.json file:

{
  "mcpServers": {
    "ververica": {
      "type": "stdio",
      "command": "vvctl",
      "timeout": 30,
      "args": ["mcp", "start"],
      "disabled": false
    }
  }
}
Codex

Use the Codex CLI to add the MCP server:

codex mcp add ververica vvctl mcp start

Alternatively, create or edit the configuration file ~/.codex/config.toml and add:

[mcp_servers.ververica]
command = "vvctl"
args = ["mcp", "start"]

For more information, see the Codex MCP documentation.

Copilot

Use the Copilot CLI to interactively add the MCP server:

/mcp add

Alternatively, create or edit the configuration file ~/.copilot/mcp-config.json and add:

{
  "mcpServers": {
    "ververica": {
      "type": "local",
      "command": "vvctl",
      "tools": ["*"],
      "args": ["mcp", "start"]
    }
  }
}

For more information, see the Copilot CLI documentation.

Cursor
  1. Go to Cursor Settings > MCP > Add new MCP Server.
  2. Enter a name for the server.
  3. Select the command type.
  4. Enter the command vvctl mcp start.

You can also verify the configuration or add command-line arguments by clicking Edit.

Factory

Use the Factory CLI to add the MCP server:

droid mcp add ververica "vvctl mcp start"

Alternatively, type /mcp within Factory Droid to open an interactive UI for managing MCP servers.

For more information, see the Factory MCP documentation.

Gemini CLI

Follow the MCP installation guide and use the standard configuration provided above.

Goose
  1. Go to Advanced settings > Extensions > Add custom extension.
  2. Enter a name for the extension.
  3. Select the STDIO type.
  4. Set the command to vvctl mcp start.
  5. Click Add Extension.
Kiro

Follow the MCP Servers documentation. For example in .kiro/settings/mcp.json:

{
  "mcpServers": {
    "ververica": {
      "command": "vvctl",
      "args": ["mcp", "start"]
    }
  }
}
LM Studio
  1. Go to Program in the right sidebar.
  2. Select Install > Edit mcp.json.
  3. Use the standard configuration provided above.
opencode

Follow the MCP Servers documentation. For example in ~/.config/opencode/opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "ververica": {
      "type": "local",
      "command": ["vvctl", "mcp", "start"],
      "enabled": true
    }
  }
}
Qodo Gen
  1. Open the Qodo Gen chat panel in VS Code or IntelliJ.
  2. Select Connect more tools > + Add new MCP.
  3. Paste the standard configuration provided above.
  4. Click Save.
VS Code

Follow the MCP installation guide and use the standard configuration provided above. You can also install the MCP server using the VS Code CLI:

# For VS Code
code --add-mcp '{"name":"ververica","command":"vvctl","args":["mcp","start"]}'

After installation, the MCP server is available for use with your GitHub Copilot agent in VS Code.

Warp
  1. Go to Settings > AI > Manage MCP Servers > + Add.
  2. Use the standard configuration provided above.

Alternatively, use the slash command /add-mcp in the Warp prompt and paste the standard configuration. For more information, see adding an MCP server.

Windsurf

Follow the Windsurf MCP documentation and use the standard configuration provided above.

Authentication​

The MCP server provides tools to manage contexts so the LLM can change contexts. This is useful for interoperating among several workspaces or accounts.

Exposed Tools​

The server exposes the following tools (names might vary slightly depending on the client UI):

  • Account: Login and logout.
  • Config: List or set users, servers, and contexts.
  • Workspaces: List workspaces and available engine versions.
  • Deployments: Create, list, get, delete, start, or stop deployments.
  • Drafts: Create, validate, run, list, or get drafts. Load SQL from a file or draft.
  • Artifacts: Create, list, get, or delete artifacts.
  • Secrets: Create, list, get, or delete secrets.
  • Logs: Access job manager, task manager, and deployment logs.
  • Agents: List agents, get agent details, and access agent Helm values.
  • Task Managers: List or get task managers for a job.
On this page