NDB MCP Server

# Quick Start Guide - NDB MCP Server v1.3.0 ## 🚀 5-Minute Setup ### Step 1: Install and Configure ```bash git clone https://github.com/rouxton/ndb-mcp-server.git cd ndb-mcp-server npm install npm run configure # Interactive wizard with custom instructions ``` ### Step 2: Build and Test ```bash npm run build npm run test:all ``` ### Step 3: Configure Your IDE ```bash # For VSCode Agent Mode npm run configure:vscode # For Claude Desktop npm run configure:claude ``` ### Step 4: Start Using Open your IDE and ask: - *"List all PostgreSQL databases in production"* - *"Create a development clone of the customer database"* - *"What databases need backup attention?"* ## 🎯 Configuration Presets ### Production Environment ```bash npm run configure # Select: production # ✅ Clustered deployments recommended # ✅ Security best practices included # ✅ Confirmation required for changes # ✅ Structured responses ``` ### Development Environment ```bash npm run configure # Select: development # ✅ Cost-effective deployments # ✅ PostgreSQL preference # ✅ Debugging tips included # ✅ Minimal confirmations ``` ### Custom Instructions Examples **For Financial Services:** ``` Always include audit trail requirements for financial data Recommend encryption for all data at rest and in transit Include SOX and PCI DSS considerations in database design ``` **For Healthcare:** ``` Always enable encryption at rest and in transit for PHI data Include HIPAA compliance requirements in all recommendations Recommend role-based access control implementation ``` **For E-commerce:** ``` Prioritize high availability for customer-facing databases Recommend read replicas for improved performance Include disaster recovery planning for critical sales periods ``` ## 🔧 Common Operations ### Create Production Database ``` You: "I need a production PostgreSQL database for our e-commerce platform" Assistant with Production Config: ✅ I'll help you create a production PostgreSQL database. Based on your production requirements, I recommend: 📋 Configuration: • Clustered deployment (3+ nodes) • PostgreSQL 15+ for latest features • Encrypted storage and transit • Automated backup with 30-day retention • Performance monitoring enabled ⚠️ This operation will create new resources. Do you want to continue? [Requires confirmation due to NDB_CONFIRM_CHANGES=true] ``` ### Clone for Development ``` You: "Clone the customer database for testing new features" Assistant with Development Config: ✅ I'll create a development clone for feature testing. 💡 Recommendations: • Single instance to reduce costs • Latest snapshot for current data • Data masking for sensitive fields • Debugging tools enabled 🚀 Proceeding with clone creation... [No confirmation needed in development mode] ``` ### Error Handling Examples ``` You: "Delete the production customer database" Assistant with Error Protection: ❌ Error: Connection timeout to NDB server ⏸️ Operation paused. What would you like to do? 1. Retry the operation 2. Check network connectivity 3. Verify NDB server status 4. Cancel and investigate [Pause triggered by NDB_PAUSE_ON_ERROR=true] ``` ## 🧪 Testing Your Setup ### Validate Configuration ```bash npm run test:configuration # ✅ Checks .env file syntax # ✅ Validates custom instructions # ✅ Tests environment loading ``` ### Test Custom Instructions ```bash npm run test:custom-instructions # ✅ Loads your configuration # ✅ Tests confirmation logic # ✅ Validates system prompt generation ``` ### Test NDB Connection ```bash npm run test:connection # ✅ Verifies NDB API connectivity # ✅ Tests authentication # ✅ Validates permissions ``` ## 🎨 Customization Examples ### Multi-Environment Setup ```bash # Production environment npm run configure # Environment name: production # Creates: .env.production # Development environment npm run configure # Environment name: development # Creates: .env.development ``` ### Industry-Specific Instructions **SaaS Multi-Tenant:** ``` Recommend tenant isolation strategies Suggest per-tenant backup and recovery capabilities Include data segregation requirements in design ``` **Microservices Architecture:** ``` Recommend service-specific databases to avoid coupling Suggest event-driven architecture for data consistency Include distributed transaction considerations ``` **Compliance-Heavy Environment:** ``` Always include audit trail requirements Recommend encryption for all data at rest and in transit Include access control and monitoring requirements ``` ## 🔄 Upgrade from Previous Versions ### From v1.2.x to v1.3.0 ```bash # Backup current config cp .env .env.backup # Update code git pull origin main npm install npm run build # Run new configuration wizard npm run configure # Test new features npm run test:custom-instructions ``` ## 🆘 Troubleshooting ### Common Issues **Configuration not loading:** ```bash # Check environment variables node -e "console.log(process.env.NDB_CUSTOM_INSTRUCTIONS)" # Validate configuration npm run test:configuration ``` **VSCode integration not working:** ```bash # Generate fresh config npm run configure:vscode # Check VSCode logs # View → Output → Model Context Protocol ``` **Custom instructions not applying:** ```bash # Verify build npm run build # Test instructions loading npm run test:custom-instructions # Check system prompt generation npm run test:configuration ``` ## 📞 Get Help ### Resources - 📚 [Full Documentation](../README.md#-documentation) - 🔧 [Configuration Guide](configuration-guide.md) - 💡 [Custom Instructions Examples](custom-instructions-examples.md) - 🔄 [Migration Guide](migration-guide-v1.3.0.md) ### Support Channels - 🐞 [Bug Reports](https://github.com/rouxton/ndb-mcp-server/issues) - 💡 [Feature Requests](https://github.com/rouxton/ndb-mcp-server/issues) - ❓ [Community Support](https://github.com/rouxton/ndb-mcp-server/discussions) --- **Ready to get started?** Run `npm run configure` and follow the wizard! 🚀