PostgreSQL MCP Server

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", "[email protected]"]
}

响应：

{
  "rows affected": 1
}

2. query_tool

执行 SELECT 查询并返回结果。

请求：

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

响应：

{
  "rows": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "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", "[email protected]"],
    [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() {
 // Create a new MCP client
 c := client.NewClient("http://localhost:8080")

 // Prepare a query request
 queryReq := map[string]interface{}{
  "statement": "SELECT * FROM users WHERE id = $1",
  "arguments": []interface{}{1},
 }

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

 // Print the response
 prettyJSON, _ := json.MarshalIndent(resp.Data, "", "  ")
 fmt.Println(string(prettyJSON))
}

安全注意事项

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

许可证

本项目采用 MIT 许可证。