🚀 PostgreSQL 模型上下文协议（Model Context Protocol）服务器
这是一个专为 PostgreSQL 数据库提供只读访问功能的模型上下文协议服务器。借助该服务器，大型语言模型（LLMs）能够查看数据库架构，并执行只读查询，为数据交互提供了便利。
🚀 快速开始
要将此服务器与 Claude Desktop 应用一起使用，请在 claude_desktop_config.json 文件的 "mcpServers" 部分添加以下配置：
Docker
- 当在 macOS 上运行 Docker 时，如果服务器在主机网络（例如 localhost）上运行，请使用
host.docker.internal - 用户名/密码可以添加到 PostgreSQL URL 中，格式为
postgresql://user:password@host:port/db-name
{
"mcpServers": {
"postgres": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"mcp/postgres",
"postgresql://host.docker.internal:5432/mydb"
]
}
}
}
NPX
{
"mcpServers": {
"postgres": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-postgres",
"postgresql://localhost/mydb"
]
}
}
}
将 /mydb 替换为您的数据库名称。
✨ 主要特性
- 为 PostgreSQL 数据库提供只读访问，保障数据安全。
- 支持大型语言模型查看数据库架构并执行只读查询。
- 提供每个表的架构信息，方便数据探查。
📦 安装指南
Docker 构建
docker build -t mcp/postgres -f src/postgres/Dockerfile .
💻 使用示例
工具使用
query
- 执行针对连接到数据库的 PostgreSQL 数据库的只读 SQL 查询。
- 输入：
sql(字符串)：要执行的 SQL 查询。 - 所有查询都在 READ ONLY（只读）事务中执行。
📚 详细文档
组件
工具
- query：可执行针对连接到数据库的 PostgreSQL 数据库的只读 SQL 查询。输入为
sql字符串，代表要执行的 SQL 查询，且所有查询都在只读事务中执行。
资源
该服务器提供每个表的架构信息：
- 表格架构 (
postgres:/// /schema)
- 每个表的 JSON 架构信息。
- 包括列名和数据类型。
- 自动从数据库元数据中发现。
使用 Claude Desktop 的方法
在使用 Claude Desktop 应用时，需在
claude_desktop_config.json文件的 "mcpServers" 部分添加相应配置。对于 Docker 和 NPX 有不同的配置方式，具体如下：Docker
- 当在 macOS 上运行 Docker 时，如果服务器在主机网络（例如 localhost）上运行，请使用
host.docker.internal。 - 用户名/密码可以添加到 PostgreSQL URL 中，格式为
postgresql://user:password@host:port/db-name。
NPX
按给定的 JSON 格式进行配置，将
/mydb替换为实际的数据库名称。📄 许可证
此 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。更多详细信息，请参阅项目存储库中的 LICENSE 文件。