MCP Postgres 查询服务器

一个模型上下文协议 (MCP) 服务器实现，用于以只读模式查询 PostgreSQL 数据库，旨在与 Claude Desktop 和其他 MCP 客户端一起使用。

概述

本项目实现了一个模型上下文协议 (MCP) 服务器，提供以下功能：

1. 一个安全、只读的 PostgreSQL 数据库接口
2. 通过 MCP 协议与 Claude Desktop 集成
3. SQL 查询验证，确保只执行 SELECT 查询
4. 查询超时保护（10 秒）

前提条件

• Node.js (v14 或更高版本)
• npm (随 Node.js 一起提供)
• PostgreSQL 数据库（连接详细信息通过命令行提供）

安装

# 克隆仓库
git clone https://github.com/RathodDarshil/mcp-postgres-query-server.git
cd mcp-postgres-query-server

# 安装依赖
npm install

# 构建项目
npm run build

连接到 Claude Desktop

您可以配置 Claude Desktop 以自动启动并连接到 MCP 服务器：

1. 访问 Claude Desktop 配置文件：

   • 打开 Claude Desktop
   • 转到 Settings > Developer > Edit Config
   • 这将在您的默认文本编辑器中打开配置文件

2. 将 postgres-query-server 添加到 claude_desktop_config.json 的 mcpServers 部分：

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/path/to/your/mcp-postgres-query-server/dist/index.js",
                "postgresql://username:password@hostname:port/database"
            ]
        }
    }
}

3. 将 /path/to/your/ 替换为您的项目目录的实际路径。
4. 将 PostgreSQL 连接字符串替换为您的实际数据库凭据。
5. 保存文件并重启 Claude Desktop。 MCP 服务器现在应该出现在 Settings 中的 MCP 服务器选择下拉列表中。

示例配置

这是一个包含 postgres-query 的完整配置文件示例：

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/Users/darshilrathod/mcp-servers/mcp-postgres-query-server/dist/index.js",
                "postgresql://user:password@localhost:5432/mydatabase"
            ]
        }
    }
}

更新配置

要更新您的 Claude Desktop 配置：

1. 打开 Claude Desktop
2. 转到 Settings > Developer > Edit Config
3. 对配置文件进行更改
4. 保存文件
5. 重启 Claude Desktop 以使更改生效
6. 如果您更新了 MCP 服务器代码，请确保在重启之前使用 npm run build 重新构建它

功能

• 只读数据库访问：为了安全起见，只允许 SELECT 查询
• 查询验证：防止潜在的有害 SQL 操作
• 超时保护：运行时间超过 10 秒的查询将自动终止
• MCP 协议支持：模型上下文协议的完整实现
• JSON 响应格式：查询结果以结构化的 JSON 格式返回

API

工具

query-postgres

针对配置的 PostgreSQL 数据库执行只读 SQL 查询。

参数：

• query (string): 要执行的 SQL SELECT 查询

响应：

• 包含以下内容的 JSON 对象：
  • rows: 结果集行
  • rowCount: 返回的行数
  • fields: 列元数据

示例：

query-postgres: SELECT * FROM users LIMIT 5

开发

主要的服务器实现在 src/index.ts 中。 关键组件：

• PostgreSQL 连接池设置
• 查询验证逻辑
• MCP 服务器配置
• 工具和资源定义

要修改服务器的行为，您可以：

• 编辑 isReadOnlyQuery() 中的查询验证逻辑
• 向 MCP 服务器添加其他工具或资源
• 修改查询超时持续时间（当前为 10 秒）

安全注意事项

• 服务器验证所有查询以确保它们是只读的
• 与数据库的连接使用 SSL
• 查询超时可防止资源耗尽
• 不允许写入操作
• 数据库凭据直接通过命令行参数传递，不存储在文件中

许可证

ISC

贡献

欢迎贡献！ 请随时提交 Pull Request。