OceanBase

v1.0.0Databasesstable

MCP Server for OceanBase database and its tools

awesome-oceanbasemcpai-integration
Share:
103
Stars
0
Downloads
0
Weekly
0/5

What is OceanBase?

OceanBase is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to mcp server for oceanbase database and its tools

MCP Server for OceanBase database and its tools

This server falls under the Databases category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • MCP Server for OceanBase database and its tools

Use Cases

Interact with OceanBase distributed database through MCP. Access and manage OceanBase tools and configurations.
oceanbase

Maintainer

LicenseApache-2.0
Languagepython
Versionv1.0.0
UpdatedMay 17, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

Manual Installation

npx awesome-oceanbase

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use OceanBase

The Awesome OceanBase MCP repository is a curated collection of eight distinct MCP servers that connect AI assistants to OceanBase's ecosystem of distributed database products and tools. It includes servers for the core OceanBase database (SQL queries and data management), OceanBase Cloud Platform (cluster monitoring), OBCloud (cloud database management), Kubernetes deployments via OKCTL, diagnostic tooling via OBDIAG, cluster operations via obshell, vector search via seekdb, and AI memory management via PowerMem. Data engineers and DBAs can use these servers to manage and query OceanBase infrastructure through natural-language prompts in Claude, Cursor, or any MCP client.

Prerequisites

  • Python 3.9 or later (most sub-servers are Python-based)
  • Access to an OceanBase instance, OBCloud account, or OCP deployment depending on which sub-server you use
  • Database credentials (host, port, username, password, database name) for the OceanBase MCP server
  • An MCP-compatible client such as Claude Desktop, Cursor, or Continue
1

Clone the repository

Download the repository which contains all eight MCP servers as separate sub-projects.

git clone https://github.com/oceanbase/awesome-oceanbase-mcp.git
cd awesome-oceanbase-mcp
2

Navigate to the target sub-server

Each MCP server lives in its own directory under src/. Choose the one matching your use case, for example the core OceanBase database server.

cd src/oceanbase_mcp_server
cat README.md
3

Install sub-server dependencies

Install Python dependencies for the chosen sub-server.

pip install -r requirements.txt
4

Configure connection environment variables

Set your OceanBase connection details as environment variables. The exact variable names depend on the sub-server; refer to each sub-server's README for the authoritative list.

export OB_HOST=your_oceanbase_host
export OB_PORT=2881
export OB_USER=root
export OB_PASSWORD=your_password
export OB_DATABASE=your_database
5

Configure your MCP client

Add the server to your MCP client configuration, pointing to the sub-server's main Python entry point.

{
  "mcpServers": {
    "oceanbase": {
      "command": "python",
      "args": ["/path/to/awesome-oceanbase-mcp/src/oceanbase_mcp_server/main.py"],
      "env": {
        "OB_HOST": "your_oceanbase_host",
        "OB_PORT": "2881",
        "OB_USER": "root",
        "OB_PASSWORD": "your_password",
        "OB_DATABASE": "your_database"
      }
    }
  }
}

OceanBase Examples

Client configuration

Example config for the core OceanBase database MCP server.

{
  "mcpServers": {
    "oceanbase": {
      "command": "python",
      "args": ["/path/to/awesome-oceanbase-mcp/src/oceanbase_mcp_server/main.py"],
      "env": {
        "OB_HOST": "127.0.0.1",
        "OB_PORT": "2881",
        "OB_USER": "root",
        "OB_PASSWORD": "your_password",
        "OB_DATABASE": "test"
      }
    }
  }
}

Prompts to try

Example prompts covering database queries, cluster monitoring, and diagnostics.

- "Show me all tables in the current OceanBase database"
- "Run a SELECT query to get the top 10 rows from the orders table"
- "What is the current cluster health status in OCP?"
- "List all nodes in the OceanBase Kubernetes deployment"
- "Search for similar documents to this text using seekdb vector search"

Troubleshooting OceanBase

Connection refused when trying to reach the OceanBase instance

Verify that OB_HOST and OB_PORT match your actual OceanBase deployment. The default MySQL-compatible port is 2881. For OBCloud deployments, use the connection string from the cloud console.

Sub-server README not found or setup steps unclear

Each server under src/ has its own README.md with specific setup instructions. Run 'ls src/' to see all available servers, then read the README in the relevant sub-directory.

Python import errors when starting a sub-server

Each sub-server may have its own requirements.txt. Make sure you installed dependencies from the correct sub-directory, not the root. Use a virtual environment per sub-server to avoid version conflicts.

Frequently Asked Questions about OceanBase

What is OceanBase?

OceanBase is a Model Context Protocol (MCP) server that mcp server for oceanbase database and its tools It connects AI assistants to external tools and data sources through a standardized interface.

How do I install OceanBase?

Follow the installation instructions on the OceanBase GitHub repository. Clone the repo, install dependencies, and add the server config to your AI client.

Which AI clients work with OceanBase?

OceanBase works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is OceanBase free to use?

Yes, OceanBase is open source and available under the Apache-2.0 license. You can use it freely in both personal and commercial projects.

Browse More Databases MCP Servers

Explore all databases servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "awesome-oceanbase": { "command": "npx", "args": ["-y", "awesome-oceanbase"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide →

Ready to use OceanBase?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides