npm package: @mcpflow.io/mcp-postgresql
Description: Read-only database access, supporting schema validation.
Author: Anthropic, PBC
Latest version: 1.0.2

# PostgreSQL

<!-- MCPFlow Packaged MCP -->
> 此包由 [MCPFlow](https://mcpflow.io) 打包并发布到npm仓库。

Read-only database access, supporting schema validation.

## 安装与使用

直接使用npx运行:

```bash
npx @mcpflow.io/mcp-postgresql
```

或者先安装后使用:

```bash
# 安装
npm install @mcpflow.io/mcp-postgresql

# 使用
npx @mcpflow.io/mcp-postgresql
```

## 使用方法

请参考原始仓库的使用说明。

## 工具函数

### retrieveContext

从AWS知识库中检索上下文信息

**参数:**

- `n`: 检索结果数量
- `query`: 检索查询文本
- `knowledgeBaseId`: AWS知识库ID

### performWebSearch

使用Brave Search API进行网络搜索

**参数:**

- `count`: 搜索结果数量
- `query`: 搜索查询文本
- `offset`: 分页偏移量

### performLocalSearch

使用Brave Local Search API进行本地搜索

**参数:**

- `count`: 搜索结果数量
- `query`: 本地搜索查询文本

### generate_image

使用EverArt模型生成图片

**参数:**

- `model`: 模型ID
- `prompt`: 所需图片的文本描述
- `image_count`: 生成图片数量

### read_file

读取文件内容

**参数:**

- `path`: 文件路径

### write_file

写入文件内容

**参数:**

- `path`: 文件路径
- `content`: 文件内容

### edit_file

编辑文件内容

**参数:**

- `path`: 文件路径
- `edits`: 编辑操作数组
- `dryRun`: 是否预览变更

### search_files

搜索文件

**参数:**

- `path`: 搜索路径
- `pattern`: 匹配模式
- `excludePatterns`: 排除模式数组

### get_file_info

获取文件信息

**参数:**

- `path`: 文件路径

### list_allowed_directories

获取允许的目录列表

**参数:**




## 原始信息

- **开发者:** modelcontextprotocol
- **版本:** 1.0.0
- **许可证:** MIT License
- **原始仓库:** [modelcontextprotocol/servers/blob/main/src/postgres](https://github.com/modelcontextprotocol/servers/blob/main/src/postgres)

## 原始README

# PostgreSQL

A Model Context Protocol server that provides read-only access to PostgreSQL databases. This server enables LLMs to inspect database schemas and execute read-only queries.

## Components

### Tools

- **query**
  - Execute read-only SQL queries against the connected database
  - Input: `sql` (string): The SQL query to execute
  - All queries are executed within a READ ONLY transaction

### Resources

The server provides schema information for each table in the database:

- **Table Schemas** (`postgres://<host>/<table>/schema`)
  - JSON schema information for each table
  - Includes column names and data types
  - Automatically discovered from database metadata

## Usage with Claude Desktop

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your `claude_desktop_config.json`:

### Docker

* when running docker on macos, use host.docker.internal if the server is running on the host network (eg localhost)
* username/password can be added to the postgresql url with `postgresql://user:password@host:port/db-name`

```json
{
  "mcpServers": {
    "postgres": {
      "command": "docker",
      "args": [
        "run", 
        "-i", 
        "--rm", 
        "mcp/postgres", 
        "postgresql://host.docker.internal:5432/mydb"]
    }
  }
}
```

### NPX

```json
{
  "mcpServers": {
    "postgres": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-postgres",
        "postgresql://localhost/mydb"
      ]
    }
  }
}
```

Replace `/mydb` with your database name.

## Building

Docker:

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

## License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.