YugabyteDB MCP Server
YugabyteDB MCP Server
Overview
What is YugabyteDB MCP Server?
YugabyteDB is a Model Context Protocol server providing read-only access to YugabyteDB databases. It enables schema inspection and execution of read-only queries, making it ideal for integrating with LLMs such as Claude, Cursor, and Windsurf Editor.
How to Use YugabyteDB MCP Server?
To use the YugabyteDB MCP server, configure it within the Claude Desktop app by adding the necessary parameters to the "mcpServers" section of the claude_desktop_config.json file. Replace the YUGABYTEDB_URL in the configuration with your specific URL.
Example:
{
"mcpServers": {
"yugabytedb-mcp": {
"command": "uv",
"args": [
"--directory",
"/path/to/cloned/yugabytedb-mcp-server/",
"run",
"src/server.py"
],
"env": {
"YUGABYTEDB_URL": "dbname=database_name host=hostname port=5433 user=username password=password load_balance=true"
}
}
}
}
Key Features of YugabyteDB MCP Server
- Executes read-only SQL queries and returns results as structured JSON.
- Provides schema inspection for all tables, including row counts and column metadata.
- Automatically discovers tables for any schema using YugabyteDB's metadata.
- Built for compatibility with Claude, Cursor, Windsurf, and other MCP clients.
- Lightweight and easy to run locally using uv.
Use Cases of YugabyteDB MCP Server
- Quickly exploring schema structure before deeper analysis.
- Generating reports or summaries through conversational interfaces.
- Prototyping analytics dashboards from natural language prompts.
- Integrating with LLMs to perform safe, read-only data exploration over distributed SQL databases like YugabyteDB.
FAQ for YugabyteDB MCP Server
Q: Is YugabyteDB MCP Server suitable for writing data?
No. It provides read-only access, meaning data cannot be modified through this server.
Q: Can I use YugabyteDB MCP Server with other apps?
Yes! While designed for Claude Desktop, it can be integrated into any application that can call its MCP endpoints.
Q: How do I get information for a particular schema?
Information for a particular schema can be accessed by asking Claude to describe that particular schema in the database. If no schema name is provided,
publicschema is used as the default.
Server Config
{
"mcpServers": {
"yugabytedb-mcp": {
"command": "uv",
"args": [
"--directory",
"/path/to/cloned/yugabytedb-mcp-server/",
"run",
"src/server.py"
],
"env": {
"YUGABYTEDB_URL": "dbname=database_name host=hostname port=5433 user=username password=password load_balance=true"
}
}
}
}