Nahmanmate Postgresql MCP Server

🚀 PostgreSQL MCP Server

A Model Context Protocol (MCP) server that provides PostgreSQL database management capabilities. This server helps analyze existing PostgreSQL setups, offers implementation guidance, and debugs database issues.

🚀 Quick Start

The PostgreSQL MCP Server is designed to streamline PostgreSQL database management. It offers a range of features to assist with analysis, setup, and debugging.

✨ Features

1. Database Analysis (analyze_database)

Analyzes PostgreSQL database configuration and performance metrics:

• Configuration analysis
• Performance metrics
• Security assessment
• Optimization suggestions

// Example usage
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "analysisType": "performance" // Optional: "configuration" | "performance" | "security"
}

2. Setup Instructions (get_setup_instructions)

Provides step-by-step guidance for PostgreSQL installation and configuration:

• Platform-specific installation steps
• Configuration recommendations
• Security best practices
• Post-installation tasks

// Example usage
{
  "platform": "linux", // Required: "linux" | "macos" | "windows"
  "version": "15", // Optional: PostgreSQL version
  "useCase": "production" // Optional: "development" | "production"
}

3. Database Debugging (debug_database)

Debugs common PostgreSQL issues:

• Connection problems
• Performance bottlenecks
• Lock conflicts
• Replication status

// Example usage
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "issue": "performance", // Required: "connection" | "performance" | "locks" | "replication"
  "logLevel": "debug" // Optional: "info" | "debug" | "trace"
}

📦 Installation

Prerequisites

• Node.js >= 18.0.0
• PostgreSQL server (for target database operations)
• Network access to the target PostgreSQL instance

Steps

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Build the server:

   npm run build
   

4. Add to the MCP settings file:

   {
     "mcpServers": {
       "postgresql-mcp": {
         "command": "node",
         "args": ["/path/to/postgresql-mcp-server/build/index.js"],
         "disabled": false,
         "alwaysAllow": []
       }
     }
   }
   

💻 Usage Examples

Basic Usage

The following are basic examples of using the main features of the server:

Database Analysis

{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "analysisType": "performance"
}

Setup Instructions

{
  "platform": "linux",
  "version": "15",
  "useCase": "production"
}

Database Debugging

{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "issue": "performance",
  "logLevel": "debug"
}

🔧 Technical Details

Development

• npm run dev - Start the development server with hot reloading.
• npm run lint - Run ESLint.
• npm test - Run tests.

Security Considerations

1. Connection Security
   • Use connection pooling.
   • Implement connection timeouts.
   • Validate connection strings.
   • Support SSL/TLS connections.
2. Query Security
   • Validate SQL queries.
   • Prevent dangerous operations.
   • Implement query timeouts.
   • Log all operations.
3. Authentication
   • Support multiple authentication methods.
   • Implement role-based access control.
   • Enforce password policies.
   • Securely manage connection credentials.

Best Practices

1. Always use secure connection strings and appropriate credentials.
2. Follow security recommendations for production environments.
3. Regularly monitor and analyze database performance.
4. Keep the PostgreSQL version up to date.
5. Implement a proper backup strategy.
6. Use connection pooling to optimize resource management.
7. Implement appropriate error handling and logging.
8. Conduct regular security audits and updates.

Error Handling

The server implements comprehensive error handling for:

• Connection failures
• Query timeouts
• Authentication errors
• Permission issues
• Resource limitations

🤝 Contribution Guidelines

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the branch.
5. Create a Pull Request.

📄 License

This project is licensed under the AGPLv3 license - see the LICENSE file for details.