yugabyte/yugabytedb-mcp-server
If you are the rightful owner of yugabytedb-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
The YugabyteDB MCP Server is an implementation that enables LLMs to interact directly with a YugabyteDB database using the Model Context Protocol.
YugabyteDB MCP Server
An MCP server implementation for YugabyteDB that allows LLMs to directly interact with your database.
Features
- List all tables in the database, including schema and row counts
- Run read-only SQL queries and return results as JSON
- Designed for use with FastMCP and compatible with MCP clients like Claude Desktop, Cursor, and Windsurf Editor
Prerequisites
- Python 3.10 or higher
- uv installed to manage and run the server
- A running YugabyteDB database
- An MCP client such as Claude Desktop or Cursor
Installation
Clone this repository and install dependencies:
git clone git@github.com:yugabyte/yugabytedb-mcp-server.git
cd yugabytedb-mcp-server
uv sync
Configuration
The server is configured using the following environment variable:
YUGABYTEDB_URL
: The connection string for your YugabyteDB database (e.g.,dbname=database_name host=hostname port=5433 user=username password=password
)
Example .env
file:
YUGABYTEDB_URL=postgresql://user:password@localhost:5433/yugabyte
Usage
Running the Server
You can run the server with STDIO
transport using uv:
uv run src/server.py
or with Streamable-HTTP
transport:
uv run src/server.py --transport http
Running the Server with Docker
Build the Docker image:
docker build -t mcp/yugabytedb .
Run the container with STDIO
transport:
docker run -p 8080:8080 -e YUGABYTEDB_URL="your-db-url" mcp/yugabytedb
or with Streamable-HTTP
transport:
docker run -p 8080:8080 -e YUGABYTEDB_URL="your-db-url" mcp/yugabytedb --transport=http
MCP Client Configuration
To use this server with an MCP client (e.g., Claude Desktop, Cursor), add it to your MCP client configuration.
Running via uv
Example configuration for Cursor:
{
"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 topology_keys=cloud.region.zone1,cloud.region.zone2"
}
}
}
}
- Replace
/path/to/cloned/yugabytedb-mcp-server/
with the path to your cloned repository. - Set the correct database URL in the
env
section.
Running via Docker (e.g., in Claude)
After building the docker container, add the following to claude_config.json
entry or equivalent json files for other editors:
{
"mcpServers": {
"yugabytedb-mcp-docker": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"YUGABYTEDB_URL=dbname=yugabyte host=host.docker.internal port=5433 user=yugabyte password=yugabyte load_balance=false",
"mcp/yugabytedb"
]
}
}
}
Claude Desktop
- Edit the configuration file. Go to Claude -> Settings -> Developer -> Edit Config
- Add the above configuration under
mcpServers
. - Restart Claude Desktop.
Claude Desktop Logs
The logs for Claude Desktop can be found in the following locations:
- MacOS: ~/Library/Logs/Claude
- Windows: %APPDATA%\Claude\Logs
The logs can be used to diagnose connection issues or other problems with your MCP server configuration. For more details, refer to the official documentation.
Cursor
- Install Cursor on your machine.
- Go to Cursor > Settings > Cursor Settings > MCP > Add a new global MCP server.
- Add the configuration as above.
- Save the configuration.
- You will see yugabytedb-mcp-server as an added server in MCP servers list. Refresh to see if server is enabled.
Cursor Logs
In the bottom panel of Cursor, click on "Output" and select "Cursor MCP" from the dropdown menu to view server logs. This can help diagnose connection issues or other problems with your MCP server configuration.
Windsurf Editor
- Install Windsurf Editor on your machine.
- Go to Windsurf > Settings > Windsurf Settings > Cascade > Model Context Protocol (MCP) Servers > Add server > Add custom server.
- Add the configuration as above.
- Save and refresh.
Streamable-HTTP with MCP Inspector
-
Start the server using Streamable-HTTP:
uv run src/server.py --transport http
Or with Docker:
docker run -p 8080:8080 -e YUGABYTEDB_URL="..." mcp/yugabytedb --transport=http
-
Launch the inspector:
npx @modelcontextprotocol/inspector
-
In the GUI, use the URL:
http://localhost:8080/invocations/mcp
- Change transport type to
Streamable-HTTP
- Add the proxy token from the terminal output
- Change transport type to
Tools Provided
- summarize_database: Lists all tables in the database, including schema and row counts.
- run_read_only_query: Runs a read-only SQL query and returns the results as JSON.
Example Usage
Once connected via an MCP client, you can:
- Ask for a summary of the database tables and schemas
- Run SELECT queries and get results in JSON
Environment Variables
YUGABYTEDB_URL
: (required) The connection string for your YugabyteDB/PostgreSQL database
Troubleshooting
- Ensure the
YUGABYTEDB_URL
is set and correct - Verify your database is running and accessible
- Check that your user has the necessary permissions
- Make sure
uv
is installed and available in your PATH. Note: If claude is unable to access uv, giving the error:spawn uv ENOENT
, try symlinking the uv for global access:
sudo ln -s "$(which uv)" /usr/local/bin/uv
- Review logs in your MCP client for connection or query errors
Development
- Project dependencies are managed in
pyproject.toml
- Main server logic is in
src/server.py