项目简介

'postgres-mcp-go' 是一个使用Go语言编写的 Model Context Protocol (MCP) 服务器实现,专为 PostgreSQL 数据库设计。它允许兼容MCP协议的客户端(例如大型语言模型,LLM)与PostgreSQL数据库进行交互,提供数据库的结构信息和安全的数据查询能力。

主要功能

  • 暴露数据库结构为资源: 自动发现并以标准化资源形式提供 PostgreSQL 数据库中每个表的详细结构信息(如列名和数据类型)。
  • 提供只读查询工具: 允许通过 MCP 协议调用工具,安全地执行只读的 SQL 查询,并返回查询结果。

安装步骤

确保您已经安装了Go语言环境。然后,您可以通过以下命令安装服务器程序:

go install github.com/iwanbk/postgres-mcp-go/cmd/postgres-mcp@latest

这将在您的Go bin目录下安装 'postgres-mcp' 可执行文件。

服务器配置

您的MCP客户端需要配置如何启动并连接到此MCP服务器。配置通常是一个包含服务器名称、启动命令及其参数的结构。

根据此项目,您需要配置以下信息:

  • 服务器名称 (serverName): 'postgres-mcp-go'
  • 启动命令 (command): 'postgres-mcp' (这是您通过'go install'安装的可执行文件名)
  • 命令参数 (args): 包含一个参数,指定PostgreSQL数据库的连接URL。例如:'-database_url=postgresql://username:password@localhost/mydb'
    • 请将 'postgresql://username:password@localhost/mydb' 替换为您实际的数据库连接字符串。

示例配置描述 (供您在MCP客户端配置时参考):

  • 'serverName': 服务器的唯一标识符,此处为 'postgres-mcp-go'。
  • 'command': 启动服务器进程的可执行文件名,此处为 'postgres-mcp'。
  • 'args': 传递给启动命令的参数列表。列表中的第一个(也是唯一一个必需的)参数是 '-database_url=<您的数据库连接URL>'。

基本使用方法

安装完成后,您可以通过命令行直接启动服务器,并通过 '-database_url' 参数指定要连接的PostgreSQL数据库:

postgres-mcp -database_url=postgresql://username:password@localhost/mydb

服务器启动后,它会通过标准输入/输出来处理MCP客户端的请求和响应。您通常不需要手动与其交互,而是由兼容的MCP客户端(如某些LLM应用)来启动和管理这个进程。

信息

分类

数据库与文件