Skip to main content
Glama
JimmyFu-Coder

PostgreSQL MCP Server

README.md
# PostgreSQL MCP Server

这是一个MCP (Model Context Protocol) 服务器,允许GPT-4等AI模型查询本地PostgreSQL数据库。

## 功能

- 执行SQL查询
- 列出数据库中的所有表
- 获取表的结构信息

## 安装

1. 克隆或下载项目
2. 安装依赖:
```bash
npm install
```

## 配置

1. 复制环境变量模板:
```bash
cp .env.example .env
```

2. 编辑 `.env` 文件,配置你的PostgreSQL连接信息:
```
DB_HOST=localhost
DB_PORT=5432
DB_NAME=your_database_name
DB_USER=your_username
DB_PASSWORD=your_password
```

## 运行

### 开发模式
```bash
npm run dev
```

### 生产模式
```bash
npm run build
npm start
```

## 在Claude Desktop中配置

在Claude Desktop的配置文件中添加以下配置:

```json
{
  "mcpServers": {
    "postgres": {
      "command": "node",
      "args": ["/path/to/your/project/index.js"],
      "env": {
        "DB_HOST": "localhost",
        "DB_PORT": "5432",
        "DB_NAME": "your_database_name",
        "DB_USER": "your_username",
        "DB_PASSWORD": "your_password"
      }
    }
  }
}
```

## 可用工具

### query_database
执行SQL查询
- `query`: SQL查询语句
- `params`: 可选的查询参数数组

### list_tables
列出数据库中的所有表

### describe_table
获取指定表的结构信息
- `table_name`: 表名

## 示例

一旦配置完成,你可以在Claude中使用以下命令:

1. "列出数据库中的所有表"
2. "描述users表的结构"
3. "查询所有用户:SELECT * FROM users LIMIT 10"