使用说明
cockroachdb-mcp服务器
使用FastAPI和CockroachDB在Python中实现的模型上下文协议(MCP)服务器。
🧠 这是什么
cockroachdb-mcp-server 是一种生产级、符合规格的MCP服务器,它:
- 实施 模型上下文协议
- 用途 蟑螂DB 作为一个有弹性的、与SQL兼容的后端
- 完全暴露 CRUD API 用于管理模型上下文
- 将上下文定义存储为 JSONB,允许任意输入/输出模式
- 与无缝协作
cockroachdb-mcp-client命令行界面
✅ 功能亮点
- ✅ 用于MCP上下文管理的REST API(
/contexts) - ✅ 通过CLI标志或env-var引导模式
- ✅ CRDB URL自动检测和方言修复
- ✅ ASCII横幅和版本信息
- ✅ 结构化日志记录和可配置日志级别
- ✅ 准备好了
/run,/deploy,/evaluate扩展
🚀 快速启动
📦 从PyPI安装
pip install cockroachdb-mcp-server
🏃 使用模式init运行
cockroachdb-mcp-server serve --init-schema --log-level INFO
或者:
export MCP_AUTO_INIT_SCHEMA=true
cockroachdb-mcp-server serve
服务器运行于
http://localhost:8081默认情况下
🔧 CLI使用情况
cockroachdb-mcp-server serve --init-schema
cockroachdb-mcp-server serve --port 8081 --host 127.0.0.1 --reload
cockroachdb-mcp-server --version
cockroachdb-mcp-server --banner
🔐 配置数据库
✅ 设置 CRDB_URL 环境变量
export CRDB_URL="postgresql://root@localhost:26257/defaultdb?sslmode=disable"
自动重写为
cockroachdb://...为了兼容性,请在引擎盖下安装。
或者,直接设置它:
export CRDB_URL="cockroachdb://root@localhost:26257/defaultdb?sslmode=disable"
✅ 支持这两种格式。
🧪 API终点
| 方法 | 路径 | 描述 |
|---|---|---|
| 职位 | /contexts |
创建上下文 |
| 得到 | /contexts |
列出所有上下文 |
| 得到 | /contexts/{id} |
按ID获取上下文 |
| PUT | /contexts/{id} |
更新上下文 |
| 删除 | /contexts/{id} |
删除上下文 |
🧱 模式自动引导
手动运行此程序:
cockroachdb-mcp-server serve --init-schema
或自动使用:
export MCP_AUTO_INIT_SCHEMA=true
创建的架构为:
CREATE TABLE IF NOT EXISTS mcp_contexts (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
context_name STRING NOT NULL,
context_version STRING NOT NULL,
body JSONB NOT NULL,
created_at TIMESTAMP DEFAULT now()
);
🔗 相关项目
- cockroachdb mcp客户端:CLI工具,用于管理MCP上下文、模拟LLM运行、导出和跨提供者的批处理模拟。
🙌 贡献
该项目专为内部和社区使用而设计。
PR欢迎扩展功能(身份验证、部署支持等), /evaluate遥测等)。