# OceanBase MCP

> OceanBase MCP connects your AI agent directly to a distributed relational database infrastructure. It lets you manage complex data systems—including clusters, tenants, and resource usage—using natural conversation instead of clicking through console dashboards. You can audit performance, check configurations, and map out entire data architectures instantly.

## Overview
- **Category:** industry-titans
- **Price:** Free
- **Tags:** distributed-database, relational-database, cluster-management, database-auditing, sql, infrastructure-as-code

## Description

Stop navigating endless cloud consoles just to find basic cluster status or resource limits. This MCP gives your AI client direct access to OceanBase's core database functions. Instead of manually checking separate tabs for tenant details or running multiple reports on resource consumption, you talk to your agent about what you need. It acts as a real-time database reliability assistant.

Need to know if the production environment is stable? Ask it. Want to audit data structures across different teams? You can ask that too. Your agent handles everything from listing all available clusters to retrieving detailed resource statistics, keeping your entire data infrastructure accurate and performant. Since you're connecting this via Vinkius, you get a single entry point for hundreds of services, meaning one connection gives your AI client access to the full scope of database operations.

## Tools

### get_cluster_details
Retrieves the specific details and current status of a single designated cluster.

### get_instance_details
Gets detailed information about an individual database instance within the system.

### get_resource_stats
Pulls combined resource usage numbers, including CPU and memory, for system performance checks.

### get_tenant_details
Retrieves the specific metadata about a logical tenant's allocated resources.

### get_workspaces
Lists and retrieves information for all available account workspaces.

### list_clusters
Generates a list of every active database cluster in your OceanBase account.

### list_databases
Lists all databases that exist within a specific tenant's scope.

### list_instances
Provides a list of all individual OceanBase database instances.

### list_projects
Lists all active projects defined within the OceanBase environment.

### list_tenants
Generates a comprehensive list of all tenants managed by the cluster.

## Prompt Examples

**Prompt:** 
```
List all database clusters in my OceanBase account.
```

**Response:** 
```
I've retrieved your OceanBase clusters. You have 3 active clusters, including 'Prod-Cluster-01' and 'Dev-Sandbox'. Would you like to view the tenants for the production cluster?
```

**Prompt:** 
```
Show me the resource usage statistics for the organization.
```

**Response:** 
```
I've retrieved the resource summary. Your organization is currently using 45% of allocated CPU capacity and 62% of memory across all instances. Storage usage is stable at 1.2TB. Should I check for any tenants hitting their limits?
```

**Prompt:** 
```
List all databases in tenant 'tenant-8821' inside cluster 'cluster-9920'.
```

**Response:** 
```
I've retrieved the databases for the specified tenant. There are 5 logical databases, including 'InventoryDB', 'CustomerPortal', and 'AnalyticsRaw'. Would you like detailed configuration for any of them?
```

## Capabilities

### Inventorying Database Infrastructure
List all active clusters and retrieve their specific configurations and current status.

### Auditing Tenants and Databases
Browse logical tenants within a cluster or list all databases belonging to a specified tenant for asset tracking.

### Tracking System Performance
Get aggregated resource usage statistics across the entire organization, checking CPU, memory, and storage limits.

### Mapping Ecosystem Components
Identify core organizational elements like projects, instances, and workspaces to maintain a unified view of your setup.

## Use Cases

### Auditing a New Department's Data Scope
A data architect needs to scope out what data exists in a new client department. They ask the agent to first run `list_tenants` to find the departmental container, then use `list_databases` on that tenant. The agent responds by listing all relevant databases and asking if they need detailed configuration for any.

### Checking Global Performance During Peak Load
An infra engineer notices strange latency spikes during peak hours. They prompt the agent to run `get_resource_stats`. The agent immediately responds with CPU and memory usage percentages, allowing them to pinpoint if a specific area needs immediate scaling.

### Troubleshooting Instance Connectivity
A backend developer reports that an application is slow. Instead of manually checking the console, they ask the agent about the instance details. The agent uses `get_instance_details` and provides all necessary connectivity metrics right in the chat.

### Mapping Out a Multi-Tiered Application
A data architect needs to document every piece of software connected to OceanBase. They ask the agent to use `list_projects` first, then check all available workspaces with `get_workspaces`, building a complete map of dependencies.

## Benefits

- Instead of running separate commands to list clusters and then checking their status manually, you simply ask the agent, which uses `list_clusters` to give you a consolidated view immediately.
- When capacity planning is necessary, the ability to use `get_resource_stats` means you get immediate, aggregate performance numbers without logging into multiple monitoring dashboards.
- You can quickly understand data boundaries by using `list_tenants` and then following up with `list_databases`, instantly identifying every data asset in a specific area.
- The agent keeps track of your entire ecosystem. Beyond databases, you get to view projects and workspaces using `list_projects` and `get_workspaces`, giving full context to any audit.
- You don't have to guess which resources are running low. By combining `get_tenant_details` with performance checks, the agent points directly to where limits are being hit.

## How It Works

The bottom line is that you talk naturally to your AI client, and it translates that request into complex database commands using this MCP.

1. Subscribe to this MCP in Vinkius and enter your OceanBase Access Key ID and Secret.
2. Connect your preferred AI client (Claude, Cursor, etc.) to the Vinkius catalog.
3. Use natural language to prompt your agent with a query about your database infrastructure.

## Frequently Asked Questions

**How do I check my resource usage with OceanBase MCP?**
Use the `get_resource_stats` tool. You simply ask your agent to retrieve aggregate resource statistics, and it will report CPU, memory, and storage usage across the entire organization.

**What if I need to see all my clusters? Do I use list_clusters?**
Yes, that’s right. Running `list_clusters` is the command you use when you need a complete inventory of every active database cluster in your account.

**Does OceanBase MCP help me find specific data structures?**
Absolutely. You can start by listing tenants with `list_tenants`, then pinpoint the exact databases using `list_databases` within that tenant's scope.

**Can I see details about a single database instance?**
Use the `get_instance_details` tool. This function pulls all necessary technical metrics and configurations for one specific OB instance so you can troubleshoot it.

**What is the difference between list_projects and get_workspaces?**
Think of projects as a grouping mechanism, which `list_projects` shows you. Workspaces are related development containers that `get_workspaces` helps you identify.