Skip to main content
Glama
README.md
# @solumon/mcp-server-confluence

用于读取 Confluence Server/DC 文档的 MCP 服务,支持图片。

## 功能特性

- 使用 CQL 搜索 Confluence 页面
- 获取页面内容(HTML 或 Wiki 格式)
- 获取页面元数据
- 列出空间
- 获取页面树结构
- 下载页面图片和附件
- 新建页面(空间根或子页面)
- 更新已有页面(标题或正文)
- 将页面移动到另一空间(可指定父页面、改名)

## 安装

本服务通过 `npx` 直接运行,无需单独安装。只需在下方配置中引用 `@solumon/mcp-server-confluence`,Cursor / Claude Code 启动时会自动拉取。

如需在命令行手动使用,也可全局安装:

```bash
npm install -g @solumon/mcp-server-confluence
```

## 配置

### 环境变量

```bash
CONFLUENCE_URL=http://your-confluence-server.com
CONFLUENCE_USERNAME=your_username
CONFLUENCE_PASSWORD=your_password
```

### Cursor 配置

添加到 `~/.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "mcp-server-confluence": {
      "command": "npx",
      "args": ["-y", "@solumon/mcp-server-confluence"],
      "env": {
        "CONFLUENCE_URL": "http://your-confluence-server.com",
        "CONFLUENCE_USERNAME": "your_username",
        "CONFLUENCE_PASSWORD": "your_password"
      }
    }
  }
}
```

### Claude Code 配置

添加到 `~/.claude.json`:

```json
{
  "mcpServers": {
    "mcp-server-confluence": {
      "command": "npx",
      "args": ["-y", "@solumon/mcp-server-confluence"],
      "env": {
        "CONFLUENCE_URL": "http://your-confluence-server.com",
        "CONFLUENCE_USERNAME": "your_username",
        "CONFLUENCE_PASSWORD": "your_password"
      }
    }
  }
}
```

## 可用工具

| 工具 | 说明 |
|------|------|
| `confluence_search` | 使用 CQL 搜索页面 |
| `confluence_get_page` | 获取页面内容(HTML/Wiki) |
| `confluence_get_page_metadata` | 获取页面元数据 |
| `confluence_list_spaces` | 列出可用空间 |
| `confluence_get_page_tree` | 获取页面树结构 |
| `confluence_list_attachments` | 列出页面附件 |
| `confluence_list_page_images` | 列出页面中引用的图片 |
| `confluence_get_page_images` | 下载页面图片(Base64) |
| `confluence_get_attachment` | 下载单个附件 |
| `confluence_create_page` | 新建页面(空间根或子页面,wiki 标记) |
| `confluence_update_page` | 更新已有页面(标题/正文,wiki 标记) |
| `confluence_move_page` | 将页面移动到另一空间(可指定父页面/改名) |

## 使用示例

### 搜索页面

```
使用 confluence_search 在空间 "PROJ" 中搜索 "需求"
```

### 获取页面内容

```
使用 confluence_get_page 获取页面 123456 的内容
```

### 获取页面图片

```
使用 confluence_get_page_images 获取页面 123456 的所有图片
```

### 下载附件

```
使用 confluence_get_attachment 从页面 123456 下载 "screenshot.png"
```

### 新建页面

```
使用 confluence_create_page 在空间 "PROJ" 新建标题为 "测试页" 的页面,内容为 wiki 标记
使用 confluence_create_page 以 parentId=123456 在指定页下新建子页面
```

### 更新页面

```
使用 confluence_update_page 更新页面 123456 的标题,或更新其正文(wiki 标记)
```

### 移动页面

```
使用 confluence_move_page 将页面 123456 移动到空间 "TARGET"
使用 confluence_move_page 将页面 123456 移到空间 "TARGET" 的父页面 789 下,并改标题为 "新标题"
```

## 许可证

MIT