Nile MCP Server

🚀 Nile MCP Server Development Documentation

The Nile MCP Server is a tool server based on the Model Context Protocol (MCP), primarily used for interacting with the Nile database. This server offers a range of functions, including database management, connection string generation, and SQL query execution.

✨ Features

• Multi-language Support: Implemented in TypeScript, it is compatible with multiple programming languages.
• Modular Design: Adopts a plug-in architecture for easy expansion and maintenance.
• High Availability: Supports cluster deployment and load balancing to ensure stable service operation.
• Security Mechanisms: Integrates authentication and permission control to safeguard data security.

🚀 Quick Start

Installation and Startup

1. Clone the project repository:

git clone https://github.com/your-repository.git
cd nile-mcp-server

2. Install dependencies:

npm install

3. Start the development server:

npm run dev

Core Tools

• Database Management

  • Create a database: POST /api/databases
  • List databases: GET /api/databases
  • Get database details: GET /api/databases/:id
  • Delete a database: DELETE /api/databases/:id

• Connection String Generation

  • Get the connection string template: GET /api/connection-strings/template
  • Generate a valid connection string: POST /api/connection-strings

💻 Usage Examples

Basic Usage

// Create a new database
const response = await fetch('/api/databases', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'my-database',
    region: 'aws-us-west-2'
  })
});

// Get all databases
const databases = await fetch('/api/databases').then(response => response.json());

📚 Documentation

Project Structure

nile-mcp-server/
├── src/
│   ├── server.ts      # Main server implementation file
│   ├── tools.ts       # Tool implementation module
│   ├── types.ts       # Type definition file
│   ├── logger.ts      # Logging utility library
│   └── index.ts       # Entry program
├── dist/             # Compiled JavaScript files
├── logs/            # Log folder
├── .env             # Environment variable configuration
├── .gitignore       # Git ignore file
├── package.json     # Project dependency management
└── tsconfig.json    # TypeScript configuration file

Key File Explanation

• server.ts: Responsible for server startup, tool registration, and message transmission handling.
• tools.ts: Implements the logic for all database operations and SQL query execution.
• types.ts: Defines interfaces and response formats related to database operations.
• logger.ts: Provides structured logging functionality, supporting daily rotation and debug mode.
• index.ts: The entry file for server startup.

🛠️ Development Guide

Script Usage

The project provides the following npm scripts:

# Compile TypeScript code
npm run build

# Start the production server
npm start

# Run in development mode with automatic rebuild support
npm run dev

# Execute the test suite
npm test

# Run ESLint to check code quality
npm run lint

# Clean build artifacts
npm run clean

Contribution Guidelines

• Code Style: Follow the Airbnb JavaScript Style Guide.
• Commit Specification: Use the Conventional Commits format.
• Collaboration Process: It is recommended to use the Git Flow branching strategy.

🔧 Technical Details

Plugin Development

You can create custom tools by extending the Tool class:

class MyCustomTool implements Tool {
  async execute(command: string, args: any[]) {
    // Custom logic implementation
  }
}

Security Considerations

• Authentication: Use JWT or OAuth2 for user authentication.
• Permission Control: Employ role-based access control (RBAC) to restrict resource operations.
• Data Encryption: Encrypt sensitive data to ensure security during transmission and storage.

📜 Documentation History

• v1.0.0: Initial version released, including basic functionality implementation.
• v2.0.0: Introduced the plugin mechanism and multi-language support.
• v3.0.0: Latest version released, adding support for high-availability clusters.

👥 Contributors

• [Your Name] - Project Maintainer
• [Contributor Name] - Core Development Member

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.