项目简介

MCP Postgres Query Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它可以让 Claude Desktop 等 MCP 客户端连接并查询 PostgreSQL 数据库。这个服务器只允许执行 'SELECT' 查询,保证数据库的安全。

主要功能点

  • 提供 PostgreSQL 数据库的只读查询接口
  • 支持 Claude Desktop 等 MCP 客户端
  • SQL 查询验证,只允许 'SELECT' 语句
  • 查询超时保护,防止长时间运行的查询
  • 以 JSON 格式返回查询结果

安装步骤

  1. 确保你已经安装了 Node.js (v14 或更高版本) 和 npm。
  2. 克隆仓库到本地:
    git clone https://github.com/RathodDarshil/mcp-postgres-query-server.git
  3. 进入项目目录:
    cd mcp-postgres-query-server
  4. 安装依赖:
    npm install
  5. 构建项目:
    npm run build

服务器配置

要将此 MCP 服务器配置到 Claude Desktop,你需要编辑 Claude Desktop 的配置文件 'claude_desktop_config.json'。在 'mcpServers' 部分添加以下配置:

{
  "mcpServers": {
    "postgres-query": {
      "command": "node",
      "args": [
        "/path/to/your/mcp-postgres-query-server/dist/index.js",
        "postgresql://<数据库用户名>:<数据库密码>@<数据库主机名>:<数据库端口>/<数据库名>"
      ]
    }
  }
}
  • '"postgres-query"': 服务器名称,可以自定义。在 Claude Desktop 的 MCP 服务器选择列表中会显示这个名称。
  • '"command": "node"': 启动命令,指定用于运行服务器的命令。这里使用 Node.js 运行 JavaScript 文件。
  • '"args"': 启动参数列表,传递给启动命令的参数。
    • '"/path/to/your/mcp-postgres-query-server/dist/index.js"': 服务器程序路径。请将 '/path/to/your/mcp-postgres-query-server' 替换为你的 'mcp-postgres-query-server' 项目 'dist/index.js' 文件的实际路径。
    • '"postgresql://<数据库用户名>:<数据库密码>@<数据库主机名>:<数据库端口>/<数据库名>"': 数据库连接字符串。请替换为你的 PostgreSQL 数据库连接信息,包括用户名、密码、主机名、端口和数据库名。

配置完成后,重启 Claude Desktop,你就可以在 MCP 服务器选择下拉菜单中看到 "postgres-query" 服务器了。

基本使用方法

配置完成后,你可以在 Claude 等 MCP 客户端中使用 'query-postgres' 工具来查询 PostgreSQL 数据库。例如,在 Claude 中,你可以这样提问:

'query-postgres: SELECT * FROM users LIMIT 5'

服务器会执行这个 SQL 查询,并将结果以 JSON 格式返回给 Claude。请确保你的 SQL 查询是 'SELECT' 语句,并且查询语句不会执行时间过长(超过 10 秒)。

信息

分类

数据库与文件