Simple PostgreSQL MCP Server

Simple PostgreSQL MCP Server

site icon
2025.04.03 25
Python数据库交互工具数据库
Simple PostgreSQL MCP Server 是一个模板项目,旨在帮助开发者快速构建自己的MCP服务器。该项目提供了与PostgreSQL数据库交互的工具、资源和提示模板,使得LLM(大型语言模型)能够通过MCP(模型上下文协议)与外部工具和数据交互。
View on GitHub

Overview

基本能力

产品定位

Simple PostgreSQL MCP Server 是一个用于构建MCP服务器的模板项目,专注于与PostgreSQL数据库的交互,为LLM提供数据库查询、资源访问和提示生成的能力。

核心功能

  1. 工具(Tools)
  2. execute_query: 运行SQL查询
  3. test_connection: 测试数据库连接

  4. 资源(Resources)

  5. db://tables: 列出所有表
  6. db://tables/{table_name}: 获取特定表的模式信息
  7. db://schema: 获取所有表的完整模式信息

  8. 提示(Prompts)

  9. 查询生成模板
  10. 分析查询构建器

适用场景

  • 自然语言查询数据库
  • 数据库模式探索
  • 数据分析与报告生成

工具列表

  • execute_query: 执行SQL查询
  • test_connection: 测试数据库连接

常见问题解答

  • 安全性: 该项目仅检查查询是否以SELECT开头,不保证其他安全性,不建议在生产环境中使用。
  • 连接问题: 如果遇到连接问题,可以使用提供的示例数据库进行测试。

使用教程

使用依赖

  • Python 3.8+
  • uv (Python包管理器)
  • npx (Node.js)
  • PostgreSQL数据库

安装教程

  1. 创建虚拟环境并安装依赖: bash uv venv source .venv/bin/activate uv pip install -r requirements.txt

  2. 运行服务器: bash npx @modelcontextprotocol/inspector uv --directory . run postgres -e DSN=postgresql://username:password@hostname:port/database -e SCHEMA=public

调试方式

  • 使用MCP Inspector界面测试连接和查询
  • 检查控制台错误信息
  • 使用示例数据库进行测试

标签信息

  • 安装类型: 未明确指定
  • 产品定位: 数据库交互工具
  • 归类: 数据库

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。