How to Use the OceanBase MCP in Claude Code

Q: How do I add the OceanBase MCP server to Claude Code?

Run the command claude mcp add --transport http oceanbase-mcp -- in your terminal. This registers the server in your local /.claude.json configuration file.

Q: Can I run OceanBase diagnostics headlessly using Claude Code?

Yes, you can command Claude Code to run getresourcestats and pipe the diagnostic output to a local log file. This makes it easy to integrate database health checks into your cron jobs.

Q: Does this OceanBase MCP Server support terminal-based management in Claude Code?

Yes, Claude Code can execute listtenants and gettenantdetails to audit resource allocation across all tenants. You get instant terminal output without opening a heavy administrative GUI.

Q: How does Claude Code handle database connection timeouts?

If listclusters or listinstances times out, Claude Code captures the standard error output directly in the terminal. The agent then reports the connection failure and suggests troubleshooting steps for your network.

Q: What database information is transmitted when using this CLI tool?

Only structural metadata, such as database schemas from listdatabases and tenant limits, is accessed. Your actual customer tables and sensitive transaction records remain untouched and isolated on your servers.

Manage distributed OceanBase clusters directly from your terminal using Claude Code headless commands and pipeline scripts.

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 Claude Code

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

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Terminal-Driven Tenant Administration

The `list_tenants` tool brings instant cluster visibility to your command line via this MCP utility. Claude Code runs this command to output tenant lists, allowing you to pipe the results into other CLI utilities or shell scripts. By calling `get_tenant_details`, you can inspect CPU and memory configurations without leaving your terminal. It replaces slow web consoles with fast, scriptable text commands.

Headless Performance Auditing

This MCP Server exposes `get_resource_stats` to automate cluster health checks inside your terminal environment. Claude Code queries this endpoint to check for resource exhaustion during deployment pipelines. It combines this with `get_instance_details` to verify that individual nodes are operating within normal parameters. You can trigger this audit via a single shell command before running database migrations.

Command-Line Workspace Management with Claude Code

The `get_workspaces` tool allows you to inspect active account environments directly through the CLI. Claude Code maps these workspaces to your local projects, ensuring your terminal session is targeting the correct environment. With `list_projects` and `list_clusters`, the agent verifies your deployment target before executing scripts. This prevents accidental changes to production systems by confirming the context first.

Setup guide

Set up OceanBase MCP in Claude Code

Prerequisites

Claude Code CLI installed (npm install -g @anthropic-ai/claude-code)
Active Vinkius subscription with a valid endpoint token

1

Run the add command

Open your terminal and run the command shown on the right. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com. Use --scope user to make it available across all projects.
2

Verify the connection

Start a Claude Code session and type /mcp to list connected servers. You should see oceanbase-mcp with a green status indicator.
3

Start using tools

Ask Claude Code something like "Check my latest OceanBase transactions." It will automatically discover and invoke the available OceanBase tools.

Terminal

claude mcp add --transport http oceanbase-mcp https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp

Get your connection token →

Prerequisites

Claude Code CLI installed
Active Vinkius subscription with a valid endpoint token

1

Open the config file

Create or edit .mcp.json in your project root for project-level scope, or ~/.claude.json for user-level scope.
2

Add the OceanBase 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

Restart Claude Code

Start a new Claude Code session. Type /mcp to confirm the server is connected. The tools will be automatically available in your conversation.

.mcp.json

{
  "mcpServers": {
    "oceanbase-mcp": {
      "type": "url",
      "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 Claude Code

Run the command `claude mcp add --transport http oceanbase-mcp -- ` in your terminal. This registers the server in your local `~/.claude.json` configuration file.

Yes, you can command Claude Code to run `get_resource_stats` and pipe the diagnostic output to a local log file. This makes it easy to integrate database health checks into your cron jobs.

Yes, Claude Code can execute `list_tenants` and `get_tenant_details` to audit resource allocation across all tenants. You get instant terminal output without opening a heavy administrative GUI.

If `list_clusters` or `list_instances` times out, Claude Code captures the standard error output directly in the terminal. The agent then reports the connection failure and suggests troubleshooting steps for your network.

Only structural metadata, such as database schemas from `list_databases` and tenant limits, is accessed. Your actual customer tables and sensitive transaction records remain untouched and isolated on your servers.

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