-
securityF
license-
qualityProvides read-only access to PostgreSQL databases, enabling LLMs to inspect database schemas and execute read-only SQL queries within a secure transaction context.
Last updated -
21,552
1
The PostgreSQL MCP Server assists with PostgreSQL database management through three main functions:
Database Analysis: Analyze database configuration, performance, and security with optimization recommendations.
Setup Instructions: Provide platform-specific installation steps for Linux, macOS, and Windows, along with configuration and security best practices.
Database Debugging: Troubleshoot common issues like connection problems, performance bottlenecks, lock conflicts, and replication status.
Offers platform-specific PostgreSQL installation and configuration guidance for Linux systems
Offers platform-specific PostgreSQL installation and configuration guidance for macOS systems
Provides PostgreSQL database management capabilities including analysis, setup instructions, and debugging for PostgreSQL database instances
PostgreSQL MCP Server
A Model Context Protocol (MCP) server that provides PostgreSQL database management capabilities. This server assists with analyzing existing PostgreSQL setups, providing implementation guidance, and debugging database issues.
Features
1. Database Analysis (analyze_database)
Analyzes PostgreSQL database configuration and performance metrics:
Configuration analysis
Performance metrics
Security assessment
Recommendations for optimization
// 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 PostgreSQL installation and configuration guidance:
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"
}
Prerequisites
Node.js >= 18.0.0
PostgreSQL server (for target database operations)
Network access to target PostgreSQL instances
Installation
Installing via Smithery
To install PostgreSQL MCP Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @nahmanmate/postgresql-mcp-server --client claude
Manual Installation
Clone the repository
Install dependencies:
npm installBuild the server:
npm run buildAdd to MCP settings file:
{ "mcpServers": { "postgresql-mcp": { "command": "node", "args": ["/path/to/postgresql-mcp-server/build/index.js"], "disabled": false, "alwaysAllow": [] } } }
Development
npm run dev- Start development server with hot reloadnpm run lint- Run ESLintnpm test- Run tests
Security Considerations
Connection Security
Uses connection pooling
Implements connection timeouts
Validates connection strings
Supports SSL/TLS connections
Query Safety
Validates SQL queries
Prevents dangerous operations
Implements query timeouts
Logs all operations
Authentication
Supports multiple authentication methods
Implements role-based access control
Enforces password policies
Manages connection credentials securely
Best Practices
Always use secure connection strings with proper credentials
Follow production security recommendations for sensitive environments
Regularly monitor and analyze database performance
Keep PostgreSQL version up to date
Implement proper backup strategies
Use connection pooling for better resource management
Implement proper error handling and logging
Regular security audits and updates
Error Handling
The server implements comprehensive error handling:
Connection failures
Query timeouts
Authentication errors
Permission issues
Resource constraints
Running evals and tests
The evals package loads an mcp client that then runs the index.ts file, so there is no need to rebuild between tests. You can see the full documentation here.
OPENAI_API_KEY=your-key npx mcp-eval src/evals/evals.ts src/index.ts
Contributing
Fork the repository
Create a feature branch
Commit your changes
Push to the branch
Create a Pull Request
License
This project is licensed under the AGPLv3 License - see LICENSE file for details.
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Facilitates management and optimization of PostgreSQL databases, offering analysis, setup guidance, and debugging, while ensuring secure and efficient database operations.
- Features
- Prerequisites
- Installation
- Development
- Security Considerations
- Best Practices
- Error Handling
- Running evals and tests
- Contributing
- License
Related Resources
Related MCP Servers
- -securityFlicense-qualityProvides read-only access to PostgreSQL databases, enabling LLMs to inspect database schemas and execute read-only SQL queries.Last updated -21,552
- AsecurityAlicenseAqualityA server that connects to PostgreSQL databases and provides tools for safely exploring schemas, running read-only SQL queries, and performing data analysis with pre-built templates.Last updated -65041MIT License
- -securityAlicense-qualityAn extended PostgreSQL management and analysis server that provides database professionals with tools for schema management, query optimization, performance monitoring, and health analysis through a collection of specialized functions.Last updated -3MIT License