PgSQL MCP Server
by twn39
PgSQL MCP Server is a powerful tool server based on the Model Context Protocol (MCP), enabling interaction with PostgreSQL databases via MCP calls. It leverages FastMCP, SQLAlchemy, and asyncpg for high-performance asynchronous database operations.
Last updated: N/A
PgSQL MCP Server
A powerful tool server based on the Model Context Protocol (MCP), enabling interaction with PostgreSQL databases via MCP calls.
🚀 Overview
This project is built on the FastMCP
framework and leverages the SQLAlchemy
and asyncpg
libraries to deliver high-performance asynchronous database operations, ensuring efficiency and responsiveness when handling database requests.
✨ Key Features
- Asynchronous & Efficient: Fully asynchronous implementation based on
asyncio
, utilizingasyncpg
for a high-performance asynchronous PostgreSQL driver. - Transactional Safety: DDL, DML, and DCL operations are executed within transactions with error handling and rollback mechanisms.
- Easy Deployment: Start the server with a simple command line interface.
📦 Installation
Ensure you have Python 3.8+ installed. Installation via uvx
is recommended:
uvx pgsql-mcp-server --dsn "postgresql://user:password@localhost:5432/db"
🔍 Preview and Debugging
You can use the official MCP Inspector tool to visually inspect the tools provided by this server, view their parameters and descriptions, and perform test calls directly.
npx @modelcontextprotocol/inspector uvx pgsql-mcp-server --dsn "postgresql://user:password@host:port/database"
This will start a local web service. Open the provided URL in your browser to begin debugging.
🤝 Contributing
Contributions are welcome! If you have suggestions for improvements, feature requests, or find any bugs, please feel free to:
- Open an Issue to discuss.
- Fork the repository and create your feature branch (
git checkout -b feature/AmazingFeature
). - Commit your changes (
git commit -m 'Add some AmazingFeature'
). - Push to the branch (
git push origin feature/AmazingFeature
). - Open a Pull Request.