YugabyteDB MCP Server

MCPAI代理

提供方 YugabyteDB

AI代理 stdio · 本地进程 无需鉴权 社区 / 第三方 Claude DesktopClaudeCursorWindsurf
查看接入方式

An MCP server implementation for YugabyteDB that allows LLMs to directly interact with your database.

一句话选型结论

按资料字段整理

YugabyteDB MCP Server 属于AI代理类 MCP 服务器,stdio · 本地进程,无需鉴权,可直接接入 Claude Desktop、Claude、Cursor 等,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类AI代理 传输方式stdio · 本地进程 鉴权无需鉴权 部署方式本地部署
GitHub 星标 8 仓库热度,无公开仓库时显示未标注
工具数 2 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

AI代理
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量2暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

yugabytedbmcppostgresql数据库交互Python本地部署LLM集成SQL查询

安装与配置

stdio · 本地进程 无需鉴权
客户端在本机拉起子进程,数据不出本机
YUGABYTEDB_URL={YUGABYTEDB_URL} uv --directory /path/to/cloned/yugabytedb-mcp-server/ run src/server.py {"YUGABYTEDB_URL":"dbname=database_name host=hostname port=5433 user=username password=password load_balance=true"}

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Python,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 2 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
给代理接外部能力

让代理在任务中途调用搜索、数据库等真实工具。

多步任务编排

把一串操作拆成步骤,由代理按顺序执行。

自动化重复流程

把固定流程交给代理跑,减少手工操作。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 2 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在AI代理场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
YugabyteDB MCP Server当前 2 stdio · 本地进程 本地部署 有 2026-05-18
Filesystem 560c4363 13 未标注 本地部署 无 2026-05-17
Server Everything (everything) 11 stdio · 本地进程 本地部署 有 2026-05-17
Time 7365cb6d 2 SSE · 服务端推送 远程部署 有 2026-05-18
Everything Claude Code 未标注 stdio · 本地进程 本地部署 有 2026-05-17
Openmemory 557e1585 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

AI代理
字段来自项目仓库与公开索引,中文说明由本站标注
提供方YugabyteDB上游标注的维护方 YugabyteDB
分类AI代理本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Python本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-18上游最后核验时间

详细介绍

8.0 KB
来自项目仓库与上游目录的原文,未做删改

YugabyteDB MCP服务器

一 主控程序 YugabyteDB的服务器实现,允许LLM直接与您的数据库交互。

特性

  • 列出数据库中的所有表,包括架构和行数
  • 运行只读SQL查询并以JSON格式返回结果
  • 设计用于 快速MCP 与Claude Desktop、Cursor和Windsurf Editor等MCP客户端兼容

先决条件

  • Python 3.10或更高版本
  • 紫外线 已安装以管理和运行服务器
  • 正在运行的YugabyteDB数据库
  • 一 MCP客户端 例如 克劳德桌面版 或 光标

安装

克隆此存储库并安装依赖项:```bash
git clone git@github.com:yugabyte/yugabytedb-mcp-server.git
cd yugabytedb-mcp-server
uv sync


## 配置

服务器配置如下:

|环境变量|参数|可选|描述|
|----------------------|----------|----------|-------------|
| `YUGABYTEDB_URL` | `--yugabytedb-url` |No | YugabyteDB数据库的连接字符串(例如。, `dbname=database_name host=hostname port=5433 user=username password=password`) |
| `YB_MCP_TRANSPORT` | `--transport` |是|要使用的传输协议: `stdio` 或 `http` (默认值: `stdio`) |
| `YB_MCP_STATELESS_HTTP` | `--stateless-http`|是|启用无状态流式HTTP模式: `true` 或 `false` (默认值: `false`) |
| `YB_AWS_SSL_ROOT_CERT_SECRET_ARN` | `--yb-aws-ssl-root-cert-secret-arn` |是|包含TLS根证书的AWS Secrets Manager密钥的ARN|
| `YB_AWS_SSL_ROOT_CERT_KEY` | `--yb-aws-ssl-root-cert-key` |Yes |选择要使用哪个证书的秘密JSON内的密钥|
| `YB_SSL_ROOT_CERT_PATH` | `--yb-ssl-root-cert-path` |是|将写入根证书的文件系统路径(默认值: `/tmp/yb-root.crt`) |
| `YB_AWS_SSL_ROOT_CERT_SECRET_REGION` | `--yb-aws-ssl-root-cert-secret-region` |是|包含TLS根证书的AWS Secrets Manager密钥的区域|

## 用法

### 运行服务器

您可以使用以下命令运行服务器 `STDIO` 使用紫外线运输:```bash
uv run src/server.py

或具有状态 Streamable-HTTP 运输:```bash
uv run src/server.py --transport http


或无国籍 `Streamable-HTTP` 运输:```bash
uv run src/server.py --transport http --stateless-http

使用Docker运行服务器

构建Docker镜像:```bash
docker build -t mcp/yugabytedb .


用以下方式运行容器 `STDIO` 运输:```bash
docker run -p 8000:8000 -e YUGABYTEDB_URL="your-db-url" mcp/yugabytedb

或与 Streamable-HTTP 运输:

状态服务器:```bash
docker run -p 8000:8000 \
-e YUGABYTEDB_URL="your-db-url" \
mcp/yugabytedb --transport=http


无状态服务器:```bash
docker run -p 8000:8000 \
-e YUGABYTEDB_URL="your-db-url" \
-e YB_MCP_TRANSPORT=http \
-e YB_MCP_STATELESS_HTTP=true \
mcp/yugabytedb

启用SSL群集的无状态服务器:```bash
docker run -p 8000:8000 \
-v /path/to/root.crt:/certs/root.crt:ro \
-e YUGABYTEDB_URL="your-db-url" \
mcp/yugabytedb \
--transport=http \
--stateless-http


### 使用AWS Secrets Manager的TLS证书运行

如果您的YugabyteDB集群启用了TLS,并且其根证书存储在AWS Secrets Manager中,则MCP服务器可以自动获取和配置它。

#### 明文秘密(PEM直接存储)

机密值包含PEM证书本身。```bash
docker run -p 8000:8000 \
-e YUGABYTEDB_URL="host=... port=5433 dbname=... user=... password=... sslmode=verify-full" \
-e YB_MCP_TRANSPORT=http \
-e YB_MCP_STATELESS_HTTP=true \
-e YB_AWS_SSL_ROOT_CERT_SECRET_ARN=arn:ofthe:secret:manager \
-e YB_AWS_SSL_ROOT_CERT_SECRET_REGION=region-of-the-secret-manager \
-e AWS_ACCESS_KEY_ID="XXX" \
-e AWS_SECRET_ACCESS_KEY="XXX" \
-e AWS_SESSION_TOKEN="XXX" \
mcp/yugabytedb

JSON密钥(一个密钥中包含多个证书)

秘密值是JSON,例如:```json

{
"cert-cluster-1": "-----BEGIN CERTIFICATE----- ...",
"cert-cluster-2": "-----BEGIN CERTIFICATE----- ..."
}


选择要使用的证书:```bash
docker run -p 8000:8000 \
-e YUGABYTEDB_URL="host=... port=5433 dbname=... user=... password=... sslmode=verify-full" \
-e YB_MCP_TRANSPORT=http \
-e YB_MCP_STATELESS_HTTP=true \
-e YB_AWS_SSL_ROOT_CERT_SECRET_ARN=arn:ofthe:secret:manager \
-e YB_AWS_SSL_ROOT_CERT_KEY=cert-cluster-1 \
-e YB_AWS_SSL_ROOT_CERT_SECRET_REGION=region-of-the-secret-manager \
-e AWS_ACCESS_KEY_ID="XXX" \
-e AWS_SECRET_ACCESS_KEY="XXX" \
-e AWS_SESSION_TOKEN="XXX" \
mcp/yugabytedb

默认情况下,证书被写入/tmp/yb-root.crt。
您可以使用以下命令覆盖此内容:```bash
-e YB_SSL_ROOT_CERT_PATH=/custom/path/root.crt


### MCP客户端配置

要将此服务器与MCP客户端(例如,Claude Desktop、Cursor)一起使用,请将其添加到MCP客户端配置中。

#### 跑步通过 `uv`

游标配置示例:```json
{
"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"
}
}
}
}
  • 替换 /path/to/cloned/yugabytedb-mcp-server/ 带有克隆存储库的路径。
  • 在中设置正确的数据库URL env 部分。

通过Docker运行(例如,在Claude中)

构建docker容器后,添加以下内容 claude_config.json 其他编辑器的条目或等效json文件:```json
{
"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"
]
}
}
}


### 克劳德桌面版

1. 编辑配置文件。转到克劳德->设置->开发人员->编辑配置
1. 在下面添加上述配置 `mcpServers`.
1. 重新启动克劳德桌面。

#### 克劳德桌面日志

Claude Desktop的日志可以在以下位置找到:

- MacOS:~/库/日志/克劳德
- Windows:%APPDATA%\\Claude\\Logs

这些日志可用于诊断连接问题或MCP服务器配置的其他问题。有关更多详细信息,请参阅 官方文件.

### 光标

1. 安装 光标 在你的机器上。
1. 转到光标>设置>光标设置>MCP>添加新的全局MCP服务器。
1. 添加上述配置。
1. 保存配置。
1. 您将在mcp服务器列表中看到yugabytedb-mcp服务器作为添加的服务器。刷新以查看服务器是否已启用。

#### 游标日志

在Cursor的底部面板中,单击“输出”,然后从下拉菜单中选择“Cursor MCP”以查看服务器日志。这可以帮助诊断连接问题或MCP服务器配置的其他问题。

### Windsurf编辑器

1. 安装 Windsurf编辑器 在你的机器上。
1. 前往Windsurf>设置>Windsurf设置>级联>模型上下文协议(MCP)服务器>添加服务器>添加自定义服务器。
1. 添加上述配置。
1. 保存并刷新。

### 带MCP检查器的流式HTTP

1. 使用Streamable HTTP启动服务器:```bash
uv run src/server.py --transport http

或者使用Docker:```bash
docker run -p 8000:8000 -e YUGABYTEDB_URL="..." mcp/yugabytedb --transport=http


1. 启动检查器:```bash
npx @modelcontextprotocol/inspector
  1. 在GUI中,使用URL:```
    http://localhost:8000/mcp

- 将运输类型更改为 `Streamable-HTTP`
- 从终端输出中添加代理令牌

### 提供的工具

- **汇总数据库**:列出数据库中的所有表,包括架构和行数。
- **run_read_only_query**:运行只读SQL查询并以JSON格式返回结果。

### 示例用法

通过MCP客户端连接后,您可以:

- 要求提供数据库表和模式的摘要
- 运行SELECT查询并获取JSON格式的结果

## 环境变量

- `YUGABYTEDB_URL`:(必填)YugabyteDB/PostgreSQL数据库的连接字符串

## 故障排除

- 确保 `YUGABYTEDB_URL` 设置正确
- 验证您的数据库是否正在运行且可访问
- 检查您的用户是否具有必要的权限
- 确保 `uv` 已安装并在PATH中可用。注意:如果claude无法访问uv,则显示错误: `spawn uv ENOENT`,尝试将uv符号链接以实现全局访问:```shell
sudo ln -s "$(which uv)" /usr/local/bin/uv
  • 查看MCP客户端中的日志,查看是否存在连接或查询错误

发展

  • 项目依赖关系在中管理 pyproject.toml
  • 主服务器逻辑在 src/server.py

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
YugabyteDB MCP Server 怎么安装?

在客户端按下面的安装命令接入:YUGABYTEDB_URL={YUGABYTEDB_URL} uv --directory /path/to/cloned/yugabytedb-mcp-server/ run src/server.py {"YUGABYTEDB_URL":"dbname=database_name host=hostname port=5433 user=username password=password load_balance=true"}。装完在客户端配置里引用同一个包或端点。

YugabyteDB MCP Server 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

YugabyteDB MCP Server 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

YugabyteDB MCP Server 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

YugabyteDB MCP Server 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、Windsurf;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

YugabyteDB MCP Server 能提供哪些能力?

资料显示约 2 个工具;能力标签包括 数据库交互、Python、Claude、SQL查询。具体工具清单以官方文档为准。

YugabyteDB MCP Server 需要什么运行环境?

运行时为 Python;属于本地进程,需要在本机装好运行环境。

YugabyteDB MCP Server 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-18。