How to Use the OceanBase MCP in VS Code Copilot

Q: How do we share the OceanBase MCP Server configuration with our team in VS Code Copilot?

Create a .vscode/mcp.json file in your repository root and commit it to Git so every team member using VS Code Copilot can instantly access the OceanBase cluster tools.

Let your team manage and inspect OceanBase clusters directly from the VS Code Copilot chat window.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect OceanBase MCP to VS Code Copilot

Create your Vinkius account to connect OceanBase to VS Code Copilot 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 OceanBase with VS Code Copilot

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Audit distributed tenants inside VS Code Copilot

The `list_tenants` tool gives VS Code Copilot the ability to inspect isolated tenant configurations across your distributed OceanBase deployments. Your team can audit resource distribution across OceanBase dev, staging, and production environments from a shared VS Code Copilot chat window. VS Code Copilot uses `get_tenant_details` to check memory and CPU limits assigned to each OceanBase tenant. This helps your team quickly identify OceanBase resource contention issues without leaving the code editor.

Run health checks with this MCP Server

This MCP Server provides the `get_resource_stats` tool to let VS Code Copilot pull real-time performance diagnostics from your OceanBase database nodes. Developers can run quick health checks during debugging sessions in VS Code Copilot to see if an OceanBase database bottleneck is causing application lag. By analyzing outputs from `get_cluster_details` and `list_clusters`, VS Code Copilot identifies offline OceanBase nodes or misconfigured clusters. It translates raw OceanBase system metrics into clear, actionable recommendations for your engineering team.

Share database context across your team

The `list_databases` tool allows VS Code Copilot to fetch the exact database catalog for any selected OceanBase tenant. By checking in the shared VS Code Copilot MCP configuration, every developer on the team gets access to the same OceanBase database structure. VS Code Copilot uses `list_projects` and `get_workspaces` to align OceanBase database resources with specific team repositories. It ensures that everyone on the team is developing against the correct OceanBase database instances.

Setup guide

Set up OceanBase MCP in VS Code Copilot

Prerequisites

VS Code 1.99 or later with GitHub Copilot extension
Active Vinkius subscription with a valid endpoint token

1

Open MCP configuration

Open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) and run "MCP: Add Server". Select HTTP (Streamable) as the server type. VS Code will create .vscode/mcp.json in your workspace.
2

Add the OceanBase MCP

Paste the JSON snippet shown on the right into your .vscode/mcp.json. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com.
3

Switch to Agent mode

Open Copilot Chat (Cmd+Shift+I / Ctrl+Shift+I) and switch to Agent mode using the dropdown. MCP tools are only available in Agent mode — they do not appear in Edit or Ask modes.
4

Verify the connection

In the Copilot Chat input, type # to list available tools. You should see the OceanBase tools listed. Try asking: "List my recent OceanBase transactions" and Copilot will invoke them automatically.

.vscode/mcp.json

{
  "mcpServers": {
    "oceanbase-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 OceanBase. 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 OceanBase 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 OceanBase MCP in VS Code Copilot

Create a `.vscode/mcp.json` file in your repository root and commit it to Git so every team member using VS Code Copilot can instantly access the OceanBase cluster tools.

No, VS Code Copilot cannot view sensitive table data because the server only exposes structural metadata like `list_databases` and `get_tenant_details` for development context.

No, VS Code Copilot communicates directly with the OceanBase server via the MCP gateway, removing any need for local database drivers on your machine.

Yes, you can ask VS Code Copilot to check OceanBase performance, and it will use `get_resource_stats` to retrieve CPU and memory metrics from your active instances.

Your OceanBase connection strings are stored securely in the Vinkius vault, meaning VS Code Copilot only receives metadata like database names and cluster stats, keeping your master passwords hidden.

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