# @aashari/mcp-server-atlassian-confluence 中文文档

规范地址：https://npmcn.com/package/%40aashari/mcp-server-atlassian-confluence/

版本：3\.3\.0
npm 元数据更新时间：2025-12-03T06:43:41.500Z
中文译文更新时间：2026-11-05T20:12:57.027Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aashari/mcp-server-atlassian-confluence
原文对照：https://npmcn.com/package/%40aashari/mcp-server-atlassian-confluence/?lang=original
项目主页：https://github.com/aashari/mcp-server-atlassian-confluence#readme
源码仓库：https://github.com/aashari/mcp-server-atlassian-confluence

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：230 kB，55 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：9 个
- 首次发布：2025-03-23T03:11:30.024Z
- 最新版本发布：2025-12-03T06:43:41.304Z
- 近 30 天下载量：30789（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：104（近 12 个月 5 个）

## 中文简介

节点.js/TypeScript MCP服务器用于阿特拉斯相交集. 提供工具,使AI系统(LLM)能够列出/获取空格和页面(内容格式为Markdown),并通过CQL搜索. 使用标准的 MCP 无缝连接 AI 与相交知识库

## 安装

```sh
npm install @aashari/mcp-server-atlassian-confluence
```

也可以使用：`pnpm add @aashari/mcp-server-atlassian-confluence`、`yarn add @aashari/mcp-server-atlassian-confluence`、`bun add @aashari/mcp-server-atlassian-confluence`

## README

# 连接 AI 到您的关联知识库

通过将克洛德,Cursor AI,以及其他AI助手直接连接到你的聚合空间,页面和文档,来转变你如何获取和与团队的知识互动. 从您的知识库获取即时答案, 搜索您的全部空间, 并精简您的文档工作流程 .

[![NPM Version](https://img.shields.io/npm/v/@aashari/mcp-server-atlassian-confluence)](https://www.npmjs.com/package/@aashari/mcp-server-atlassian-confluence)

## 你能做什么吗

-   **问AI你的文件**:"我们的API认证程序是什么?"
-   **搜索所有空格**:"寻找关于安全最佳做法的所有页面"
-   **获取即时答案**:"给我看看产品空间的最新发行说明"
-   **获取团队知识**:"我们远程工作的人力资源政策是什么
-   **评论**:"给我看看关于建筑文件的讨论"
-   **创建并更新内容**:"在DEV空间创建新页面"

## 完美为

-   **开发者** 需要迅速获得技术文件和API指南的人
-   **产品管理员** 搜索要求、规格和项目更新
-   **人力资源小组** 快速获取政策文件和雇员资源
-   **支助小组** 寻找解决问题的指南和知识库文章
-   **谁都行** 想要用自然语言与相交

## 快速启动

两分钟后起床跑道:

### 1\. 获得你的影响力证书

生成组合 API 键 :

1.  转到 [地图集API 键](https://id.atlassian.com/manage-profile/security/api-tokens)
2.  点击 **创建 API 令牌**
3.  给它一个名字像 **阿联酋助理**
4.  **复制生成的令牌** 立刻,你不会再看到它了

### 2\. 立即尝试

```bash
# Set your credentials
export ATLASSIAN_SITE_NAME="your-company"  # for your-company.atlassian.net
export ATLASSIAN_USER_EMAIL="your.email@company.com"
export ATLASSIAN_API_TOKEN="your_api_token"

# List your Confluence spaces
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces"

# Get details about a specific space
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces/123456"

# Get a page with JMESPath filtering
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/pages/789" --jq "{id: id, title: title, status: status}"
```

## 连接到 AI 助理

### 对于 Claude 桌面用户

将此添加到您的 Claude 配置文件( E)`~/.claude/claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "confluence": {
      "command": "npx",
      "args": ["-y", "@aashari/mcp-server-atlassian-confluence"],
      "env": {
        "ATLASSIAN_SITE_NAME": "your-company",
        "ATLASSIAN_USER_EMAIL": "your.email@company.com",
        "ATLASSIAN_API_TOKEN": "your_api_token"
      }
    }
  }
}
```

重新启动克洛德桌面,你会看到状态栏中的聚合服务器.

### 其他助理助理

大多数AI助手支持MCP. 在全球安装服务器 :

```bash
npm install -g @aashari/mcp-server-atlassian-confluence
```

然后配置您的 AI 助手使用 STIO 传输的 MCP 服务器 .

### 选项: 配置文件

创建 `~/.mcp/configs.json` 全系统配置:

```json
{
  "confluence": {
    "environments": {
      "ATLASSIAN_SITE_NAME": "your-company",
      "ATLASSIAN_USER_EMAIL": "your.email@company.com",
      "ATLASSIAN_API_TOKEN": "your_api_token"
    }
  }
}
```

**替代配置密钥 :** 系统还接受 `"atlassian-confluence"`, (中文(简体) ), `"@aashari/mcp-server-atlassian-confluence"`,或 `"mcp-server-atlassian-confluence"` 改为 `"confluence"`。 。 。 .

## 可用工具

这个 MCP 服务器提供了5个通用工具,可以访问任何 Copulation API 端点:

| 工具 | 说明 |
| --- | --- |
| `conf_get` | 获取任何聚合 API 端点( 读取数据) |
| `conf_post` | POST 到任何终点( 创建资源) |
| `conf_put` | PUT 到任意终点(替换资源) |
| `conf_patch` | PATCH 任意终点( 部分更新) |
| `conf_delete` | DELETE 任意终点( 调走资源) |

### 常见 API 路径

**空间 :**

-   `/wiki/api/v2/spaces` - 列出所有空格
-   `/wiki/api/v2/spaces/{id}` - 获取空间细节

**页: 1**

-   `/wiki/api/v2/pages` - 列表页(使用 `space-id` 要过滤的查询参数)
-   `/wiki/api/v2/pages/{id}` - 获取页面细节
-   `/wiki/api/v2/pages/{id}/body` - 获取页面正文(使用) `body-format` (第1款)
-   `/wiki/api/v2/pages/{id}/children` - 获取儿童页面
-   `/wiki/api/v2/pages/{id}/labels` - 获取页面标签

**评论:**

-   `/wiki/api/v2/pages/{id}/footer-comments` - 列表/添加页脚注释
-   `/wiki/api/v2/pages/{id}/inline-comments` - 列表/添加内置注释
-   `/wiki/api/v2/footer-comments/{comment-id}` - 获得/更新/删除评论

**博客文章 :**

-   `/wiki/api/v2/blogposts` - 列表博客文章
-   `/wiki/api/v2/blogposts/{id}` - 获取博客文章

**搜索 :**

-   `/wiki/rest/api/search` - 搜索内容(使用) `cql` 查询段落)

### JMESPath 过滤

所有工具都支持可选 JMESPath (`jq`过滤以提取具体数据:

```bash
# Get just space names and keys
npx -y @aashari/mcp-server-atlassian-confluence get \
  --path "/wiki/api/v2/spaces" \
  --jq "results[].{id: id, key: key, name: name}"

# Get page title and status
npx -y @aashari/mcp-server-atlassian-confluence get \
  --path "/wiki/api/v2/pages/123456" \
  --jq "{id: id, title: title, status: status}"
```

## 现实世界实例

### 探索您的知识库

问你的人工智能助手:

-   _"把宇宙中所有的空间都找出来"_
-   _"给我看看工程空间的细节"_
-   _"我们产品空间里有什么页面?"_
-   _"在营销空间找到最新页面"_

### 搜索和查找信息

问你的人工智能助手:

-   _"搜索关于API认证的页面"_
-   _"找到标题中包含"安全"的所有文件"_
-   _"给我看贴有"开始"的页面"_
-   _搜索DEV空间内关于部署的内容_

### 访问特定内容

问你的人工智能助手:

-   _"获取API认证指南页面内容"_
-   _"给我看看登机清单文件"_
-   _"我们的安保政策页面是什么?"_
-   _"播放最新发行笔记"_

### 创建并更新内容

问你的人工智能助手:

-   _在 DEV 空间创建新页面,名为“ API 指南 ”_
-   _"添加对架构文档的评论"_
-   _"用新发布信息更新页面内容"_

## CLI 命令

CLI 镜像 MCP 直接终端访问的工具 :

```bash
# GET request
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces"

# GET with query parameters
npx -y @aashari/mcp-server-atlassian-confluence get \
  --path "/wiki/api/v2/pages" \
  --query-params '{"space-id": "123456", "limit": "10"}'

# POST request (create a page)
npx -y @aashari/mcp-server-atlassian-confluence post \
  --path "/wiki/api/v2/pages" \
  --body '{"spaceId": "123456", "status": "current", "title": "New Page", "body": {"representation": "storage", "value": "<p>Content here</p>"}}'

# POST request (add a comment)
npx -y @aashari/mcp-server-atlassian-confluence post \
  --path "/wiki/api/v2/pages/789/footer-comments" \
  --body '{"body": {"representation": "storage", "value": "<p>My comment</p>"}}'

# PUT request (update page - requires version increment)
npx -y @aashari/mcp-server-atlassian-confluence put \
  --path "/wiki/api/v2/pages/789" \
  --body '{"id": "789", "status": "current", "title": "Updated Title", "spaceId": "123456", "body": {"representation": "storage", "value": "<p>Updated content</p>"}, "version": {"number": 2}}'

# DELETE request
npx -y @aashari/mcp-server-atlassian-confluence delete \
  --path "/wiki/api/v2/pages/789"
```

## 解决问题

### "校正失败"或"403紫禁"

1.  **检查您的 API 调试权限**数字 :
    
    -   转到 [地图集API 键](https://id.atlassian.com/manage-profile/security/api-tokens)
    -   确定你的代币还在使用中, 并且还没有过期
2.  **校验您的站点名称格式**数字 :
    
    -   如果您的组合 URL 是 `https://mycompany.atlassian.net`
    -   你的网站名应该只是 `mycompany`
3.  **测试您的证书**数字 :
    
    ```bash
    npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces?limit=1"
    ```
    

### "未找到资源"或"404"

1.  **检查 API 路径**数字 :
    
    -   路径对大小写敏感
    -   对空格和页面使用数字标识(不是密钥)
    -   校验浏览器中存在的资源
2.  **验证访问权限**数字 :
    
    -   确保您可以访问浏览器中的空间/ 页面
    -   一些内容可能仅限于某些用户

### 搜索时找不到结果

1.  **尝试不同的搜索术语**数字 :
    
    -   高级搜索使用 CQL 语法
    -   尝试更广泛的搜索标准
2.  **检查 CQL 语法**数字 :
    
    -   在 Conference 的高级搜索中先验证您的 CQL

### Claude 桌面整合问题

1.  **重新启动 Claude 桌面** 更新配置文件后
2.  **验证配置文件位置**数字 :
    -   马可斯: `~/.claude/claude_desktop_config.json`
    -   窗口 : `%APPDATA%\Claude\claude_desktop_config.json`

### 获取帮助

如果你仍然有问题:

1.  运行一个简单的测试命令来验证所有工作
2.  检查 [GitHub 问题](https://github.com/aashari/mcp-server-atlassian-confluence/issues) 类似的问题
3.  以错误消息创建新问题并设置细节

## 经常被问到的问题

### 我需要什么许可?

您的Atlassian账户需要:

-   **访问聚合物** 包含您想要查询的空格的适当权限
-   **API 令牌** 拥有适当的许可(在创建时自动授予)

### 我能用这个和相干服务器吗?

目前,此工具只支持 **相会云**. 未来版本中可能添加聚合服务器/数据中心支持.

### 我该怎么找到我的网站名?

您的网站名称是您的聚合 URL 的第一部分 :

-   URL : `https://mycompany.atlassian.net` - > 站点名称: `mycompany`
-   URL : `https://acme-corp.atlassian.net` - > 站点名称: `acme-corp`

### 人工智能助理是做什么工作的?

任何支持模式背景协议的AI助手:

-   克劳德桌面
-   光标AI
-   继续. dev
-   许多其他

### 我的数据安全吗?

没错! 此工具 :

-   完全运行在您的本地机器上
-   使用您自己的交汇证书
-   从不向第三方发送数据
-   只访问您允许它访问的内容

### 我能马上搜索所有空间吗?

没错! 使用 CQL 查询进行跨空间搜索 。 例如:

```bash
npx -y @aashari/mcp-server-atlassian-confluence get \
  --path "/wiki/rest/api/search" \
  --query-params '{"cql": "type=page AND text~\"API documentation\""}'
```

## 从 v2.x 迁移

3.0版本用5个通用的HTTP方法工具来取代8+特定工具. 如果你从v2.x升级:

**在(v2.x)之前:**

```
conf_ls_spaces, conf_get_space, conf_ls_pages, conf_get_page,
conf_search, conf_ls_comments, conf_add_comment, ...
```

**在(v3.0)之后:**

```
conf_get, conf_post, conf_put, conf_patch, conf_delete
```

**移徙实例:**

-   `conf_ls_spaces` - > (中文) `conf_get` 有路径 `/wiki/api/v2/spaces`
-   `conf_get_space` - > (中文) `conf_get` 有路径 `/wiki/api/v2/spaces/{id}`
-   `conf_ls_pages` - > (中文) `conf_get` 有路径 `/wiki/api/v2/pages?space-id={id}`
-   `conf_get_page` - > (中文) `conf_get` 有路径 `/wiki/api/v2/pages/{id}`
-   `conf_search` - > (中文) `conf_get` 有路径 `/wiki/rest/api/search?cql=...`
-   `conf_add_comment` - > (中文) `conf_post` 有路径 `/wiki/api/v2/pages/{id}/footer-comments`

## 支助

需要帮忙吗? 如何获得援助:

1.  **检查上面的故障排除区域** - 涉及最常见的问题
2.  **访问 GitHub 仓库** 文件和实例: [github.com/aashari/mcp-server-atlassian-相交点](https://github.com/aashari/mcp-server-atlassian-confluence)
3.  **报告问题** 时间 [GitHub 问题](https://github.com/aashari/mcp-server-atlassian-confluence/issues)
4.  **开始讨论** 专题请求或一般问题

* * *

_照顾希望将AI带入知识管理流程的团队._

## 常见问题

### @aashari/mcp-server-atlassian-confluence 是什么？

节点\.js/TypeScript MCP服务器用于阿特拉斯相交集\. 提供工具,使AI系统\(LLM\)能够列出/获取空格和页面\(内容格式为Markdown\),并通过CQL搜索\. 使用标准的 MCP 无缝连接 AI 与相交知识库

### 如何安装 @aashari/mcp-server-atlassian-confluence？

在项目目录运行 npm install @aashari/mcp-server-atlassian-confluence，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 mcp-atlassian-confluence，可以用 npx mcp-atlassian-confluence 直接运行。

### @aashari/mcp-server-atlassian-confluence 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aashari/mcp-server-atlassian-confluence 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @aashari/mcp-server-atlassian-confluence 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aashari/mcp-server-atlassian-confluence 可以商用吗？

@aashari/mcp-server-atlassian-confluence 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aashari/mcp-server-atlassian-confluence 的下载量有多少？

根据 npm 官方下载统计，@aashari/mcp-server-atlassian-confluence 在 2026/10/05 – 2026/11/03 这 30 天内被下载 30,789 次，日均约 1,026 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aashari/mcp-server-atlassian-confluence 还在维护吗？

最新版本 3\.3\.0 发布于 2025/12/03（11 个月前）；至今共发布 104 个版本，其中过去 12 个月发布了 5 个；首次发布于 2025/03/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。