Postgres MCP

🚀 PostgreSQL 模型上下文协议 (Model Context Protocol) 服务器

本服务器提供对 PostgreSQL 数据库的只读访问功能，借助它，大型语言模型（LLMs）能够查看数据库架构并执行只读查询，为数据交互提供便利。

🚀 快速开始

若要将此服务器与 Claude Desktop 应用程序配合使用，需在 claude_desktop_config.json 文件的 "mcpServers" 部分添加相应配置。具体配置方式如下：

Docker

{
  "mcpServers": {
    "postgres": {
      "command": "docker",
      "args": [
        "run", 
        "-i", 
        "--rm", 
        "mcp/postgres", 
        "postgresql://host.docker.internal:5432/mydb"
      ]
    }
  }
}

⚠️ 重要提示

当在 macOS 上运行 Docker 且服务器运行在主机网络（例如 localhost）时，请使用 host.docker.internal。同时，用户名/密码可以添加到 PostgreSQL URL 中，格式为 postgresql://user:password@host:port/db-name。

NPX

{
  "mcpServers": {
    "postgres": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-postgres",
        "postgresql://localhost/mydb"
      ]
    }
  }
}

请将 /mydb 替换为您的数据库名称。

✨ 主要特性

工具

• query
  • 可执行针对连接数据库的只读 SQL 查询。
  • 输入参数为 sql（字符串），即要执行的 SQL 查询。
  • 所有查询均在 READ ONLY 事务中执行。

资源

该服务器能提供每个表的架构信息：

• 表架构 (postgres://<host>/<table>/schema)
  • 以 JSON 格式呈现每个表的架构信息。
  • 包含列名和数据类型。
  • 这些信息会自动从数据库元数据中发现。

📦 安装指南

Docker 构建

docker build -t mcp/postgres -f src/postgres/Dockerfile .

📄 许可证

此 MCP 服务器依据 MIT License 进行分发。这意味着您可以自由使用、修改和分发该软件，但需遵循 MIT License 的条款和条件。有关详细信息，请查阅项目存储库中的 LICENSE 文件。