PostgreSQL

PostgreSQL

site icon
2025.02.14 3
JavaScript数据库访问PostgreSQL 工具数据库
mcp-pg-schema 是一个基于 Model Context Protocol 的服务,提供对 PostgreSQL 数据库的只读访问能力。该服务允许 LLMs(大型语言模型)检查数据库模式并执行只读查询。
View on GitHub

Overview

基本能力

产品定位

mcp-pg-schema 是一个数据库访问工具,专注于提供对 PostgreSQL 数据库的只读访问和模式检查功能。

核心功能

  1. 只读查询执行:通过 query 工具执行只读 SQL 查询。
  2. 模式检查:提供数据库表的 JSON 模式信息,包括列名和数据类型。
  3. 自动发现:从数据库元数据中自动发现表模式。

适用场景

  1. 数据库模式检查:开发人员或 LLMs 可以快速了解数据库结构。
  2. 只读数据分析:执行安全的只读查询以获取数据,而不影响数据库状态。
  3. 数据库文档生成:利用模式信息自动生成数据库文档。

工具列表

  • query
  • 能力:对连接的数据库执行只读 SQL 查询。
  • 输入:sql(字符串):要执行的 SQL 查询。
  • 注意:所有查询都在 READ ONLY 事务中执行。

常见问题解答

  1. 如何在 macOS 上使用 Docker 运行服务?
  2. 如果服务器运行在主机网络上(例如 localhost),请使用 host.docker.internal 作为主机名。

  3. 如何添加用户名和密码?

  4. 可以在 PostgreSQL URL 中添加用户名和密码,格式为:postgresql://user:password@host:port/db-name

使用教程

使用依赖

  1. 确保已安装 Docker 或 Node.js(用于 NPX 安装方式)。

安装教程

Docker 方式

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

NPX 方式

无需安装,直接使用 NPX 运行。

调试方式

  1. Docker 调试sh docker run -i --rm mcp/postgres postgresql://host.docker.internal:5432/mydb

  2. NPX 调试sh npx -y @modelcontextprotocol/server-postgres postgresql://localhost/mydb

注意:将 /mydb 替换为您的实际数据库名称。

许可证

该项目遵循 MIT 开源许可条款。