mcp-oceanbase

English | [简体中文](README_CN.md) # OceanBase MCP Server A Model Context Protocol (MCP) server that enables secure interaction with OceanBase databases. This server allows AI assistants to list tables, read data, and execute SQL queries through a controlled interface, making database exploration and analysis safer and more structured. ## 📋 Table of Contents - [Features](#-features) - [Available Tools](#%EF%B8%8F-available-tools) - [Prerequisites](#-prerequisites) - [Installation](#-installation) - [From Source Code](#from-source-code) - [From PyPI Repository](#from-pypi-repository) - [Configuration](#%EF%B8%8F-configuration) - [Quickstart](#-quickstart) - [Stdio Mode](#stdio-mode) - [SSE Mode](#sse-mode) - [Streamable HTTP](#streamable-http) - [Advanced Features](#-advanced-features) - [Authorization](#-authorization) - [AI Memory System](#-ai-memory-system) - [Examples](#-examples) - [Security](#-security) - [License](#-license) - [Contributing](#-contributing) ## ✨ Features - **Database Operations**: List tables, read data, execute SQL queries - **AI Memory System**: Persistent vector-based memory powered by OceanBase - **Advanced Search**: Full text search, vector search, and hybrid search - **Security**: Authorization support and secure database access - **Monitoring**: Comprehensive logging and ASH reports - **Multi-Transport**: Support for stdio, SSE, and Streamable HTTP modes ## 🛠️ Available Tools ### Core Database Tools - [✔️] **Execute SQL queries** - Run custom SQL commands - [✔️] **Get current tenant** - Retrieve current tenant information - [✔️] **Get all server nodes** - List all server nodes (sys tenant only) - [✔️] **Get resource capacity** - View resource capacity (sys tenant only) - [✔️] **Get ASH report** - Generate [Active Session History](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002013776) reports ### Search & Memory Tools - [✔️] **Search OceanBase documents** - Search official documentation (experimental) - [✔️] **AI Memory System** - Vector-based persistent memory (experimental) - [✔️] **Full text search** - Search documents in OceanBase tables - [✔️] **Vector similarity search** - Perform vector-based similarity searches - [✔️] **Hybrid search** - Combine relational filtering with vector search > **Note**: Experimental tools may have API changes as they evolve. ## 📋 Prerequisites You need to have an OceanBase database. You can: - **Install locally**: Refer to [this documentation](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000003378290) - **Use OceanBase Cloud**: Try [OceanBase Cloud](https://www.oceanbase.com/free-trial) for free ## 🚀 Installation ### From Source Code #### 1. Clone the repository ```bash git clone https://github.com/oceanbase/awesome-oceanbase-mcp.git cd awesome-oceanbase-mcp/src/oceanbase_mcp_server ``` #### 2. Install Python package manager and create virtual environment ```bash curl -LsSf https://astral.sh/uv/install.sh | sh uv venv source .venv/bin/activate # or `.venv\Scripts\activate` on Windows ``` #### 3. Configure environment (optional) If you want to use `.env` file for configuration: ```bash cp .env.template .env # Edit .env with your OceanBase connection details ``` #### 4. Handle network issues (optional) If you encounter network issues with uv, use Alibaba Cloud mirror: ```bash export UV_DEFAULT_INDEX="https://mirrors.aliyun.com/pypi/simple/" ``` #### 5. Install dependencies ```bash uv pip install . ``` ### From PyPI Repository For quick installation via pip: ```bash uv pip install oceanbase-mcp ``` ## ⚙️ Configuration There are two ways to configure OceanBase connection information: ### Method 1: Environment Variables Set the following environment variables: ```bash OB_HOST=localhost # Database host OB_PORT=2881 # Optional: Database port (defaults to 2881 if not specified) OB_USER=your_username OB_PASSWORD=your_password OB_DATABASE=your_database ``` ### Method 2: .env File Configure in the `.env` file (copy from `.env.template` and modify as needed). ## 🚀 Quickstart The OceanBase MCP Server supports three transport modes: ### Stdio Mode Add the following content to your MCP client configuration file: ```json { "mcpServers": { "oceanbase": { "command": "uv", "args": [ "--directory", "path/to/awesome-oceanbase-mcp/src/oceanbase_mcp_server", "run", "oceanbase_mcp_server" ], "env": { "OB_HOST": "localhost", "OB_PORT": "2881", "OB_USER": "your_username", "OB_PASSWORD": "your_password", "OB_DATABASE": "your_database" } } } } ``` ### SSE Mode Start the server in SSE mode: ```bash uv run oceanbase_mcp_server --transport sse --port 8000 ``` **Parameters:** - `--transport`: MCP server transport type (default: stdio) - `--host`: Host to bind to (default: 127.0.0.1, use 0.0.0.0 for remote access) - `--port`: Port to listen on (default: 8000) **Alternative startup (without uv):** ```bash cd oceanbase_mcp/ && python3 -m server --transport sse --port 8000 ``` **Configuration URL:** `http://ip:port/sse` ### Streamable HTTP Start the server in Streamable HTTP mode: ```bash uv run oceanbase_mcp_server --transport streamable-http --port 8000 ``` **Alternative startup (without uv):** ```bash cd oceanbase_mcp/ && python3 -m server --transport streamable-http --port 8000 ``` **Configuration URL:** `http://ip:port/mcp` #### Client Configuration Examples **VSCode Extension Cline:** ```json "streamable-ob": { "autoApprove": [], "disabled": false, "timeout": 60, "type": "streamableHttp", "url": "http://ip:port/mcp" } ``` **Cursor:** ```json "streamable-ob": { "autoApprove": [], "disabled": false, "timeout": 60, "type": "streamableHttp", // "type": "http" is also acceptable "url": "http://ip:port/mcp" } ``` **Cherry Studio:** - MCP → General → Type: Select "Streamable HTTP (streamableHttp)" from dropdown ## 🔧 Advanced Features ### 🔐 Authorization Configure the `ALLOWED_TOKENS` variable in environment variables or `.env` file. Add `"Authorization": "Bearer <token>"` to the MCP Client request header. Only requests with valid tokens can access the MCP server service. **Example:** ```bash ALLOWED_TOKENS=tokenOne,tokenTwo ``` ### Client Configuration **Cherry Studio:** - Add `Authorization=Bearer <token>` to MCP → General → Headers input field **Cursor:** ```json { "mcpServers": { "ob-sse": { "autoApprove": [], "disabled": false, "timeout": 60, "type": "sse", "url": "http://ip:port/sse", "headers": { "Authorization": "Bearer <token>" } } } } ``` **Cline:** - Cline does not support setting Authorization in request headers - Refer to this [issue](https://github.com/cline/cline/issues/4391) for updates ### 🧠 AI Memory System **Experimental Feature**: Transform your AI assistant with persistent vector-based memory powered by OceanBase's advanced vector capabilities. The memory system enables your AI to maintain continuous context across conversations, eliminating the need to repeat personal preferences and information. Four intelligent tools work together to create a seamless memory experience: - **`ob_memory_query`** - Semantically search and retrieve contextual memories - **`ob_memory_insert`** - Automatically capture and store important conversations - **`ob_memory_delete`** - Remove outdated or unwanted memories - **`ob_memory_update`** - Evolve memories with new information over time ### 🚀 Quick Setup Memory tools are **disabled by default** to avoid the initial embedding model download (0.5~4 GiB). Enable intelligent memory with these environment variables: ```bash ENABLE_MEMORY=1 # default 0 disabled， set 1 to enable EMBEDDING_MODEL_NAME=BAAI/bge-small-en-v1.5 # default BAAI/bge-small-en-v1.5, You can set BAAI/bge-m3 or other models to get better experience. EMBEDDING_MODEL_PROVIDER=huggingface ``` ### 📋 Prerequisites **Vector Support**: Requires OceanBase v4.3.5.3+ (vector features enabled by default) ```bash sudo docker run -p 2881:2881 --name obvector -e MODE=mini -d oceanbase/oceanbase-ce:4.3.5.3-103000092025080818 ``` **Legacy Versions**: For older OceanBase versions, manually configure [ob_vector_memory_limit_percentage](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000003381620). ### ⬇️ Dependency Installation **Source Code Installation:** ```bash cd path/to/mcp-oceanbase/src/oceanbase_mcp_server uv pip install -r pyproject.toml --extra memory ``` **PyPI Installation:** ```bash uv pip install oceanbase-mcp[memory] --extra-index-url https://download.pytorch.org/whl/cpu ``` **🎯 Memory System Benefits:** - ✅ **Cross-Session Continuity** - No need to reintroduce yourself - ✅ **Intelligent Semantic Search** - Understands related concepts and context - ✅ **Personalized Experience** - AI truly "knows" your preferences - ✅ **Automatic Capture** - Important information saved without manual effort ## 📚 Examples Below are some examples demonstrating the capabilities of OceanBase MCP Server: ### Example 1: Listing Tables Question: ```plaintext How many tables are there in the test database, and what are they? ``` Answer: ```plaintext Tables in test: t1 t2 ``` ### Example 2: View the current tenant Question: ``` What is my current tenant name? ``` Answer: ``` Your current tenant name is 'sys'. ``` ### Example 3: View server nodes You need to be sys tenant to get all server nodes. Question: ``` Query all server nodes ``` Answer: ``` Successfully queried all server nodes. Here are the details: | SVR_IP | SVR_PORT | ID | ZONE | SQL_PORT | WITH_ROOTSERVER | STATUS | START_SERVICE_TIME | STOP_TIME | BLOCK_MIGRATE_IN_TIME | CREATE_TIME | MODIFY_TIME | BUILD_VERSION | LAST_OFFLINE_TIME | |----------|----------|----|-------|----------|-----------------|--------|---------------------------|-----------|-----------------------|-------------------------|-------------------------|------------------------------------------------------------------------------|-------------------| | 127.0.0.1 | 2882 | 1 | zone1 | 2881 | YES | ACTIVE | 2024-06-27 15:40:19.003123 | None | None | 2024-06-19 16:39:11.749421 | 2024-06-27 15:40:21.001573 | 4.2.3.1_101000012024061216-c436ab3557c826ab31931d11ec836dc4df09d9de(Jun 12 2024 16:25:30) | None | This table provides comprehensive information about each server node, including IP addresses, ports, zones, statuses, and timestamps. ``` ### Example 4: View resource capacity You need to be sys tenant to get resource capacity. Question: ``` Query the current resource capacity information ``` Answer: ``` The current resource capacity information has been successfully queried. Here are the details: | SVR_IP | SVR_PORT | ZONE | SQL_PORT | CPU_CAPACITY | CPU_CAPACITY_MAX | CPU_ASSIGNED | CPU_ASSIGNED_MAX | MEM_CAPACITY | MEM_ASSIGNED | LOG_DISK_CAPACITY | LOG_DISK_ASSIGNED | LOG_DISK_IN_USE | DATA_DISK_CAPACITY | DATA_DISK_IN_USE | DATA_DISK_HEALTH_STATUS | MEMORY_LIMIT | DATA_DISK_ALLOCATED | DATA_DISK_ABNORMAL_TIME | SSL_CERT_EXPIRED_TIME | |----------|----------|-------|----------|--------------|------------------|--------------|------------------|--------------|--------------|-------------------|-------------------|-----------------|--------------------|-----------------|-------------------------|--------------|---------------------|-------------------------|-----------------------| | 127.0.0.1 | 2882 | zone1 | 2881 | 4 | 4.0 | 2.0 | 2.0 | 5368709120 | 3221225472 | 5368709120 | 4294967296 | 3556769792 | 10737418240 | 664797184 | NORMAL | 6442450944 | 10737418240 | None | None | This table provides comprehensive information about the resource capacities and assignments for the server. ``` ### Example 5: Get ASH report Get OceanBase Active Session History report. Question: ``` Please provide me with today's ASH report. ``` Answer: ``` The ASH report for today (2025-09-03) has been successfully generated. Key findings include: Cluster Overview: - Name: ob6u2klmn4pwo0 - Observer Version: OceanBase 4.3.5.2 - OS: Linux(5.10.134-17.2.al8.x86_64)_x86_64 - Analysis period: 2025-09-03 00:00:00 to 2025-09-03 11:26:40 - Average Active Sessions: 0.45 Top Activity: 1. Tenant t6wxyssara4e8 dominated background activity (99.99%) 2. Nodes 10.102.32.82, 10.102.64.254, and 10.102.49.151 showed highest activity 3. Primary activities: - TenantWeakReadService generating cluster versions - LogService I/O operations - TimerWK background tasks - LSRecoveryService reporting Resource Utilization: - Main wait events: exec inner sql wait (various), palf write, sync rpc - Top IO operations: COMPACTION tasks (TX_TABLE_MERGE, MINI_MERGE) - Primary SQL activity: SELECT statements (17.36% of activity) The complete report contains detailed breakdowns of: - Node-specific activity - IO bandwidth usage - Latch waits - Object access patterns - Execution phases - SQL execution statistics Would you like me to extract or highlight any specific sections of the report? ``` ### Example 6: Search for documents using full text search Question: ``` Find content in t2 table that mention "apple" ``` Answer: ``` I have successfully queried the documents in the content field of table t2 that mention "apple". Here are the results: 1. Document ID: 2, Author: john, Age: 20, Content: I have a pear and an apple 2. Document ID: 1, Author: david, Age: 19, Content: I have a pineapple and an apple 3. Document ID: 3, Author: tom, Age: 21, Content: I also have a pear and an apple ``` ### Example 7: Search records by vector similarity Question: ``` Please search for records in table t2 that are close to the vector [0.1, 0.1, 0.1]. ``` Answer: ``` The vector search on table t2 has returned results successfully. I can now analyze and present these results to the user. The search found three records that are close to the vector [0.1, 0.1, 0.1]: 1. Record with id 2, name 'john', age 20, description 'I have a pear and an apple', vector '[0.1,0.1,0.2]', and distance 0.1 2. Record with id 3, name 'tom', age 21, description 'I also have a pear and an apple', vector '[0.1,0.1,0.2]', and distance 0.1 3. Record with id 1, name 'david', age 19, description 'I have a pineapple and an apple', vector '[0.1,0.2,0.3]', and distance 0.2236 These records are ordered by their distance from the search vector, with closer matches appearing first. ``` ### Example 8: Perform hybird search Perform hybird search combining relational condition filtering(that is, scalar) and vector search. Using both vectors and scalars as query conditions. Question: ``` Please find the record in table t2 that has a vector close to [0.1, 0.1, 0.2] and an age of 20. ``` Answer: ``` The record in table `t2` that has a vector close to `[0.1, 0.1, 0.2]` and an age of 20 is: (2, 'john', 20, 'I have a pear and an apple', '[0.1,0.1,0.2]', 0.0) ``` ### Example 9: cross-session intelligent memory Experience the power of cross-session intelligent memory: ``` 📅 Monday Conversation User: "I love football and basketball, but I don't like swimming. I work in Shanghai using Python." AI: "Got it! I've saved your preferences and work information!" 💾 [Automatically calls ob_memory_insert to save preference data] 📅 Wednesday Conversation User: "Recommend some sports I might be interested in" AI: 🔍 [Automatically calls ob_memory_query searching "sports preferences"] "Based on your previous preferences, I recommend football and basketball activities! Since you mentioned not liking swimming, here are some great land-based sports..." 📅 One Week Later User: "Where do I work and what programming language do I use?" AI: 🔍 [Automatically calls ob_memory_query searching "work programming"] "You work in Shanghai and primarily use Python for development." ``` ## 🔒 Security This MCP server requires database access to function. Follow these security best practices: ### Essential Security Measures 1. **Create a dedicated OceanBase user** with minimal permissions 2. **Never use root credentials** or administrative accounts 3. **Restrict database access** to only necessary operations 4. **Enable logging** for audit purposes 5. **Regular security reviews** of database access ### Security Checklist - ❌ Never commit environment variables or credentials to version control - ✅ Use a database user with minimal required permissions - ✅ Consider implementing query whitelisting for production use - ✅ Monitor and log all database operations - ✅ Use authorization tokens for API access ### Detailed Configuration See [OceanBase Security Configuration Guide](./SECURITY.md) for detailed instructions on: - Creating a restricted OceanBase user - Setting appropriate permissions - Monitoring database access - Security best practices > ⚠️ **IMPORTANT**: Always follow the principle of least privilege when configuring database access. ## 📄 License Apache License - see [LICENSE](LICENSE) file for details. ## 🤝 Contributing We welcome contributions! Please follow these steps: 1. **Fork the repository** 2. **Create your feature branch** ```bash git checkout -b feature/amazing-feature ``` 3. **Commit your changes** ```bash git commit -m 'Add some amazing feature' ``` 4. **Push to the branch** ```bash git push origin feature/amazing-feature ``` 5. **Open a Pull Request**