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

This PostgreSQL MCP Server offers a range of functions to manage and optimize your PostgreSQL databases. Below are some basic usage examples to get you started quickly.

✨ Features

1. Database Analysis (analyze_database)

Analyze 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. Installation Instructions (get_setup_instructions)

Provide 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)

Debug 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

Installation via Smithery

To automatically install via Smithery:

npm install -g @nahmanmate/postgresql-mcp-server

Manual Installation

Clone the repository and run:

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm start

💻 Usage Examples

Basic Usage

The following example demonstrates how to use the analyze_database function:

try {
  const result = await postgresqlMCPService.analyzeDatabase({
    connectionString: "postgresql://user:password@localhost:5432/dbname",
    analysisType: "performance"
  });
  console.log(result);
} catch (error) {
  console.error("An error occurred: ", error.message);
}

Advanced Usage

For more complex scenarios, you can combine multiple functions to achieve comprehensive database management.

🔧 Technical Details

Development

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm run dev

Security Considerations

• Ensure the security configuration of the PostgreSQL server.
• Use strong passwords and access controls.
• Regularly back up the database.
• Monitor performance and errors.

Best Practices

• Use connection pooling to manage database connections.
• Configure appropriate query timeouts.
• Use role-based access control.
• Enable logging and monitoring.

📄 License

MIT License

Copyright (c) 2024 nahmanmate

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🤝 Contribution Guidelines

To contribute code, please fork the repository and submit your changes on the main branch.