MCP 服务器

NDB MCP Server

Enables Claude and other MCP-compatible AI assistants to manage Nutanix Database Service (NDB) environments through natural language, supporting database operations like provisioning, cloning, backups, and monitoring with customizable instructions and behavior controls.

README

NDB MCP Server

A Model Context Protocol server that enables Claude Desktop and other MCP-compatible AI assistants to manage Nutanix Database Service (NDB) environments through natural language with custom instructions support.

Transform complex database operations into simple conversations: "Create a clone of the sales database for testing" or "Show me all databases with backup issues".

🆕 New in v1.3.0: Custom Instructions Support

Configure your NDB assistant's behavior:

✅ Confirmation prompts before creation operations
⏸️ Pause on errors with user guidance options
📝 Customizable response styles (concise, verbose, structured)
🛠️ Behavioral instructions via environment variables

Quick Start

🚀 5-Minute Setup Guide - Get started immediately with presets and examples

Prerequisites

Node.js 18.0.0 or later
NDB Environment with API access
Valid credentials with appropriate permissions

Installation

Clone and setup:

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

The setup script handles everything: dependencies, building, configuration, testing, and prepares for Claude Desktop integration.

Configure Claude Desktop:

./scripts/configure-claude.sh                      # Unix/Linux/macOS
# or  
.\scripts\configure-claude.ps1                    # Windows PowerShell

Start using:

Restart Claude Desktop to load the new configuration
Try asking Claude: "List all databases in NDB"

Manual configuration (if needed):

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

🛠️ Enhanced Configuration Wizard

The configuration wizard now includes comprehensive setup for custom instructions:

npm run configure

Configuration Features

🔧 Basic Settings:

NDB connection and authentication
SSL verification and timeouts
Multi-environment support

📋 Custom Instructions:

Preset configurations for common scenarios (production, development, security, performance)
Industry-specific examples (financial, healthcare, e-commerce, SaaS)
Database engine preferences (PostgreSQL, Oracle, MongoDB)
Infrastructure patterns (microservices, data lakes, edge computing)

⚙️ Behavior Controls:

Confirmation settings for high-impact operations
Error handling with pause/continue options
Response styles (concise, verbose, structured)

Quick Start Examples

Production Environment:

npm run configure
# Choose: production preset
# Result: Clustered deployments, security focus, confirmation required

Development Environment:

npm run configure
# Choose: development preset  
# Result: Cost-effective, PostgreSQL preference, minimal confirmations

Custom Setup:

npm run configure
# Choose: custom
# Add your specific organizational guidelines

🗣️ "Show me all PostgreSQL databases in production" 📋 Lists all PostgreSQL databases with production status and health indicators

🗣️ "Create a clone of the customer-data database for testing" 🔄 Creates a fresh clone using the latest snapshot, ready for development use

🗣️ "Take a snapshot of the critical-app database" 📸 Creates an immediate backup snapshot with automatic retention policies

🗣️ "Check which time machines had backup failures" 🚨 Analyzes time machine health and reports any backup issues

What You Can Do

Databases	Clones	Backups	Infrastructure
List & monitor	Create & refresh	Snapshots & recovery	Cluster monitoring
Provision new	Manage lifecycle	Time machine status	Server health
Register existing	Resource allocation	Retention policies	Alerts & operations
Update properties	Cleanup & removal	Health monitoring	Capacity planning

Documentation

📖 Complete Setup Guide - Detailed installation, configuration, and security

🔧 Tools Reference - Complete documentation of all available tools

💡 Usage Examples - Real-world scenarios and workflows

Architecture Overview

High-Level Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│ Conversational  │◄──►│        MCP      │◄──►│       NDB       │
│      Agent      │    │      Server     │    │                 │
└─────────────────┘    └─────────────────┘    └─────────────────┘
        │                        │                        │
        │                        │                        │
    MCP Protocol           NDB REST API              Database
 (stdio/websocket)         (HTTP/HTTPS)             Operations

Core Components

MCP Server Core (src/index.ts)
- Protocol handling and tool registration
- Request/response management
- Error handling and logging
NDB Client (src/ndb-client.ts)
- HTTP client for NDB API
- Authentication management
- Request retries and error handling
Tool Definitions (src/tools.ts)
- 30+ tool implementations
- Parameter validation
- Response formatting
Type Definitions (src/types.ts)
- TypeScript interfaces
- API response types
- Configuration schemas
Utilities (src/utils.ts)
- Helper functions
- Data transformations
- Validation logic