README Documentation
🌊 Awesome OceanBase MCP
Model Context Protocol (MCP) Server Collection for OceanBase Ecosystem
English | 简体中文
📖 Project Overview
awesome-oceanbase-mcp is a Model Context Protocol (MCP) server repository specifically designed for the OceanBase ecosystem.
🎯 Mission: Enable AI assistants to interact directly with OceanBase databases and ecosystem components through standardized MCP protocols.
✨ Core Values:
- 🤖 AI-Friendly: Direct database operations within Claude, ChatGPT and other AI assistants
- 🔒 Secure & Reliable: Provides safe database access and operation mechanisms
- 🛠️ Complete Ecosystem: Covers the complete OceanBase product and tool chain
- 🚀 Ready to Use: Simple configuration to get started
🔍 What is MCP?
The Model Context Protocol (MCP) is an open protocol designed to enable seamless integration between AI applications and external data sources and tools. It provides a standardized way for AI models to access the contextual information and capabilities they need.
🚀 Quick Start
Prerequisites
If you don't have an OceanBase database instance yet, please:
- Visit OceanBase Official Repository to get the latest version
- Or use OceanBase Online Trial for quick setup
🗂️ MCP Server Collection
This repository provides complete MCP servers for the OceanBase ecosystem:
| 🔧 MCP Server | 📝 Description | 📚 Documentation |
|---|---|---|
| OceanBase MCP Server | Provides secure interaction capabilities with OceanBase databases, supporting SQL queries, data management operations | 📖 View |
| OCP MCP Server | Integrates with OceanBase Cloud Platform, providing cluster management and monitoring capabilities | 📖 View |
| OBCloud MCP Server | Connects to OBCloud services, providing cloud database management functionality | 📖 View |
| OKCTL MCP Server | Manages OceanBase resources and deployments in Kubernetes environments | 📖 View |
| OBDIAG MCP Server | Provides OceanBase diagnostic tool integration, supporting performance analysis and troubleshooting | 📖 View |
| obshell MCP Server | Enables OceanBase cluster creation, deployment and operations management through obshell | 📖 View |
💡 Usage Tips: Click on the documentation links to view detailed installation and configuration guides.
💬 Community & Support
We highly value community feedback and contributions!
🙋♀️ Getting Help
- 💬 Technical Discussion: Visit OceanBase Community Forum to connect with developers and community partners
- 📧 Technical Support: Get official technical support through the community forum
- 📖 Documentation Hub: Check OceanBase Official Documentation
🐛 Issue Reporting
If you encounter any issues during usage:
- First check the documentation for the corresponding MCP server
- Search existing Issues to confirm if the issue is known
- If it's a new issue, please create a new Issue
🤝 Contributing
We welcome all forms of contributions:
- 🔧 Code Contribution: Submit Pull Requests
- 📝 Documentation: Improve docs and examples
- 🐛 Bug Reports: Report bugs and suggest improvements
- 💡 Feature Requests: Propose new feature requirements
📄 License
This project is released under the Apache License 2.0.
⭐ If this project is helpful to you, please give us a Star!
Made with ❤️ by OceanBase Team