项目简介

PostgreSQL Schema Inspector 是一个 MCP 服务器，它允许大型语言模型 (LLM) 客户端通过 Model Context Protocol (MCP) 协议访问 PostgreSQL 数据库的 Schema 信息。该服务器提供资源 (Table Schemas) 和工具 (query)，使 LLM 能够理解数据库结构并执行只读查询。

主要功能点

• 提供数据库表结构的 JSON Schema 信息资源。
• 支持通过 'query' 工具执行只读 SQL 查询。

安装步骤

Docker 镜像方式:

1. 确保您已安装 Docker。
2. 使用 Docker 镜像 'mcp/postgres' 运行该 MCP 服务器。

NPX 方式:

1. 确保您已安装 Node.js 和 npm。
2. 使用 NPX 命令直接运行该 MCP 服务器，无需额外安装步骤。

服务器配置

为了使 MCP 客户端能够连接到 PostgreSQL Schema Inspector 服务器，您需要在客户端的 MCP 服务器配置中添加以下信息。

Docker 配置示例:

{
  "mcpServers": {
    "postgres": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "mcp/postgres",
        "postgresql://host.docker.internal:5432/mydb"  // 数据库连接 URL，请替换为您的 PostgreSQL 数据库 URL，如果 Docker 运行在 macOS 上且数据库在宿主机，请使用 host.docker.internal
      ]
    }
  }
}

NPX 配置示例:

{
  "mcpServers": {
    "postgres": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-postgres",
        "postgresql://localhost/mydb" // 数据库连接 URL，请替换为您的 PostgreSQL 数据库 URL
      ]
    }
  }
}

配置参数说明:

• 'server name': 'postgres' (用户自定义，用于在客户端中标识该服务器)
• 'command': 指定启动服务器的命令。Docker 方式为 'docker'，NPX 方式为 'npx'。
• 'args': 启动命令的参数列表。
  • Docker 方式包含 'run -i --rm mcp/postgres' 和 数据库连接 URL。
  • NPX 方式包含 '-y @modelcontextprotocol/server-postgres' 和 数据库连接 URL。
  • 重要: 请将示例配置中的 'postgresql://host.docker.internal:5432/mydb' 或 'postgresql://localhost/mydb' 替换为您实际的 PostgreSQL 数据库连接 URL。

基本使用方法

配置好 MCP 客户端后，客户端将能够：

1. 列出资源: 客户端可以请求列出该服务器提供的所有资源，即数据库中所有表的 Schema 信息。
2. 读取资源: 客户端可以请求读取特定表的 Schema 信息，服务器将返回 JSON 格式的 Schema 数据。
3. 调用工具: 客户端可以使用 'query' 工具执行只读 SQL 查询，以获取数据库中的数据。 (具体工具使用方法请参考客户端文档)