PostgreSQL MCP 服务器

这是一个模型上下文协议 (MCP) 服务器，提供与 PostgreSQL 数据库交互的接口。它允许您通过标准化的 API 执行查询、执行数据库操作和管理事务。

功能特性

• 执行带有参数化输入的 SQL 查询
• 执行数据库操作 (INSERT, UPDATE, DELETE)
• 执行包含多个语句的事务
• 检索数据库模式信息
• 安全的参数处理，防止 SQL 注入

安装

1. 克隆仓库：

   git clone https://github.com/yourusername/postgres-mcp.git
   cd postgres-mcp
   

2. 安装依赖：

   go mod download
   

3. 配置您的数据库连接：

   cp .env.example .env
   

   编辑 .env 文件，填入您的 PostgreSQL 数据库凭据。

4. 构建服务器：

   go build -o postgres-mcp
   

5. 运行服务器：

   ./postgres-mcp
   

使用方法

服务器公开以下 MCP 工具：

1. execute_tool

执行单个 SQL 语句。

请求：

{
  "statement": "INSERT INTO users(name, email) VALUES($1, $2)",
  "arguments": ["Jane Doe", "jane@example.com"]
}

响应：

{
  "rows affected": 1
}

2. query_tool

执行 SELECT 查询并返回结果。

请求：

{
  "statement": "SELECT * FROM users WHERE id = $1",
  "arguments": [1]
}

响应：

{
  "rows": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com"
    }
  ],
  "columns": ["id", "name", "email"],
  "rowCount": 1
}

3. transaction_tool

在事务中执行多个语句。

请求：

{
  "statements": [
    "INSERT INTO users(name, email) VALUES($1, $2)",
    "INSERT INTO user_roles(user_id, role) VALUES($1, $2)"
  ],
  "arguments": [
    ["Alice", "alice@example.com"],
    [1, "admin"]
  ]
}

响应：

{
  "results": [
    {
      "statement": 0,
      "rowsAffected": 1
    },
    {
      "statement": 1,
      "rowsAffected": 1
    }
  ]
}

4. schema_tool

检索表的模式信息。

请求：

{
  "table_name": "users"
}

响应：

{
  "table": "users",
  "columns": [
    {
      "name": "id",
      "type": "integer",
      "nullable": false,
      "default": "nextval('users_id_seq'::regclass)"
    },
    {
      "name": "name",
      "type": "character varying",
      "nullable": false,
      "default": null
    },
    {
      "name": "email",
      "type": "character varying",
      "nullable": false,
      "default": null
    }
  ]
}

客户端示例

以下是如何使用 MCP 客户端与服务器交互的示例：

package main

import (
 "encoding/json"
 "fmt"
 "log"

 "github.com/mark3labs/mcp-go/client"
)

func main() {
 // 创建一个新的 MCP 客户端
 c := client.NewClient("http://localhost:8080")

 // 准备一个查询请求
 queryReq := map[string]interface{}{
  "statement": "SELECT * FROM users WHERE id = $1",
  "arguments": []interface{}{1},
 }

 // 执行查询
 resp, err := c.Execute("query_tool", queryReq)
 if err != nil {
  log.Fatalf("Failed to execute query: %v", err)
 }

 // 打印响应
 prettyJSON, _ := json.MarshalIndent(resp.Data, "", "  ")
 fmt.Println(string(prettyJSON))
}

安全注意事项

• 始终使用参数化查询来防止 SQL 注入攻击
• 限制数据库用户权限，仅限于必要的权限
• 在生产环境中使用 SSL/TLS 进行数据库连接
• 为 MCP 服务器实施适当的身份验证和授权

许可证

该项目根据 MIT 许可证获得许可。