NDB MCP 服务器
一个模型上下文协议(MCP)服务器,它使Claude Desktop和其他MCP兼容的AI助手能够通过自然语言管理Nutanix数据库服务(NDB)环境 自定义指令支持。
将复杂的数据库操作转化为简单的对话: *“为测试创建销售数据库的克隆版本”* 或者 *“显示所有存在备份问题的数据库”*。
🆕 v1.3.0 新增功能:支持自定义指令
配置您的NDB助手的行为:
- ✅ 确认提示 在创建操作之前
- ⏸️ 表示暂停。 遇到错误时暂停 带有用户指导选项
- 📝 可定制的响应风格 (简洁,冗长,结构化)
- 🛠️(扳手) 行为指南/行为说明 通过环境变量
快速入门
🚀 表情符号“🚀”在中文中通常被翻译为“火箭”或保持原样作为表情使用,因为它本身是一个通用的表情符号,代表火箭发射、快速前进等含义。所以,直接翻译就是“🚀”(火箭)。在具体语境中,可以根据需要选择是否翻译为文字描述。 5分钟设置指南 - 立即开始,使用预设和示例
先决条件
- Node.js 18.0.0 或更高版本
- NDB环境 使用API访问
- 有效的凭证 具有适当的权限
安装
- 克隆并设置:
git clone https://github.com/rouxton/ndb-mcp-server.git
cd ndb-mcp-server
# Run the automated setup script
./scripts/setup.sh # Unix/Linux/macOS
# or
PowerShell -ExecutionPolicy Bypass -File scripts/setup.ps1 # Windows PowerShell安装脚本负责处理所有事务:依赖项管理、构建、配置、测试,并为Claude Desktop集成做好准备。
- 配置Claude桌面版:
./scripts/configure-claude.sh # Unix/Linux/macOS
# or
.\scripts\configure-claude.ps1 # Windows PowerShell- 开始使用:
- 重启 Claude 桌面应用以加载新配置 - 试着问问Claude:“列出NDB中的所有数据库”
手动配置 (如需):
npm run configure # Interactive configuration wizard with custom instructions
npm run test:connection # Test NDB connectivity
npm run test:configuration # Test configuration validity
npm run test:mcp # Test MCP functionality🛠️ 增强的配置向导
配置向导现在包含了自定义指令的全面设置:
npm run configure配置特性
🔧 基本设置:
- NDB连接与认证
- SSL验证和超时设置
- 多环境支持
📋 自定义说明:
- 预设配置 针对常见场景(生产、开发、安全、性能)
- 行业特定示例 (金融、医疗、电子商务、SaaS)
- 数据库引擎首选项 (PostgreSQL,Oracle,MongoDB)
- 基础设施模式 (微服务、数据湖、边缘计算)
⚙️ 行为控制:
- 确认设置 用于高影响力操作
- 错误处理 带有暂停/继续选项
- 应答风格 (简洁,冗长,结构化)
快速入门示例
生产环境:
npm run configure
# Choose: production preset
# Result: Clustered deployments, security focus, confirmation required开发环境:
npm run configure
# Choose: development preset
# Result: Cost-effective, PostgreSQL preference, minimal confirmations自定义设置:
npm run configure
# Choose: custom
# Add your specific organizational guidelines🗣️ “显示生产环境中所有的 PostgreSQL 数据库” 📋 列出所有具有生产状态和健康指标的 PostgreSQL 数据库
🗣️ “为测试创建一个客户数据数据库的克隆” 🔄 使用最新的快照创建一个全新的克隆,准备用于开发
🗣️(说话的表情符号,无具体文字对应,表示说话或交谈) “对关键应用数据库进行快照备份” 📸 立即创建备份快照,并自动应用保留策略
🗣️ “检查哪些时间机器发生了备份失败” 🚨 分析时光机(或时间机器,此处根据上下文可能指某种备份系统或设备)的健康状况,并报告任何备份问题
你能做什么
| 数据库 | 克隆体 | 备份 | 基础设施 |
|---|---|---|---|
| 列表与监控 | 创建与刷新 | 快照与恢复 | 集群监控 |
| 提供新资源 | 管理生命周期 | 时间机器状态 | 服务器健康状况 |
| 注册现有资源 | 资源分配 | 保留策略 | 提醒与操作 |
| 更新属性 | 清理与移除 | 健康监测 | 容量规划 |
文档
📖 书籍 完整设置指南 - 详细的安装、配置和安全设置
🔧 (这个符号本身在中文中没有直接的对应翻译,它通常表示“扳手”或“修理工具”的意思,但在没有上下文的情况下,可以简单理解为“工具”或“修理相关的符号”。) 工具参考 - 所有可用工具的完整文档
💡 灵感/想法/智慧之光 使用示例 - 真实世界场景和工作流程
架构概述
高层架构
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ Conversational │◄──►│ MCP │◄──►│ NDB │
│ Agent │ │ Server │ │ │
└─────────────────┘ └─────────────────┘ └─────────────────┘
│ │ │
│ │ │
MCP Protocol NDB REST API Database
(stdio/websocket) (HTTP/HTTPS) Operations核心组件
- MCP 服务器核心 (
src/index.ts)
- 协议处理和工具注册 - 请求/响应管理 - 错误处理和日志记录
- NDB 客户端 (
src/ndb-client.ts)
- NDB API的HTTP客户端 - 身份验证管理 - 请求重试和错误处理
- 工具定义 (
src/tools.ts)
- 30多种工具的实现 - 参数验证 - 响应格式化
- 类型定义 (
src/types.ts)
- TypeScript 接口 - API响应类型 - 配置模式(或配置架构)
- 公用事业 (
src/utils.ts)
- 辅助函数 - 数据转换 - 验证逻辑
📚 文档
📖 配置与设置:
- 🚀 表情符号“🚀”通常表示火箭、快速进展或高度兴奋的状态,在中文中可以简单翻译为“🚀(火箭/快速进展/兴奋状态)”,但具体翻译可能根据上下文有所不同。 快速入门指南 - 5分钟设置,包含预设和示例
- 配置指南 - 高级配置和自定义指令
- 自定义指令示例 - 行业特定及用例示例
- 迁移指南 v1.3.0 - 升级到v1.3.0版本,并应用自定义指令
- 自定义指令API - 技术API参考
🔧 技术参考:
支持与贡献
许可证
MIT 许可证 - 请参阅 许可证 详情请参阅。
______________________________________________________________________
准备好用AI来变革您的数据库管理了吗? 🚀 表情符号“🚀”在中文中通常被翻译为“火箭”或保持为“🚀”(直接使用原符号),具体取决于上下文和表达需求。在这里,我可以将其简单地描述为“火箭”或保留原样。
从……开始 安装指南 以获取详细说明。
