Atlassian Confluence MCP 服务器

这是一个为 Atlassian Confluence Cloud 设计的 Node.js/TypeScript 模型上下文协议（MCP）服务器。它能让 AI 系统（如 Claude 或 Cursor AI 等大语言模型）安全地实时访问你的 Confluence 空间、页面和内容。

为什么使用这个服务器？

最小输入，最大输出：简单的标识符即可提供全面详情，无需额外参数。
完整知识库访问：让 AI 助手能够查看文档、Wiki 和知识库内容。
丰富的内容格式化：自动将 Atlassian 文档格式转换为可读的 Markdown。
安全的本地认证：使用你的凭证在本地运行，从不将令牌存储在远程服务器上。
直观的 Markdown 响应：所有输出都采用结构良好、一致的 Markdown 格式。

什么是 MCP？

模型上下文协议（MCP）是一个开放标准，用于安全地连接 AI 系统与外部工具和数据源。这个服务器为 Confluence Cloud 实现了 MCP，使 AI 助手能够通过编程方式与你的 Confluence 内容交互。

前提条件

Node.js（>=18.x）：下载
Atlassian 账户：需要有访问 Confluence Cloud 的权限

设置

第一步：获取你的 Atlassian API 令牌

访问你的 Atlassian API 令牌管理页面：https://id.atlassian.com/manage-profile/security/api-tokens
点击 创建 API 令牌。
给它一个描述性的标签（例如 mcp-confluence-access）。
点击创建。
立即复制生成的 API 令牌。你之后将无法再次看到它。

第二步：配置凭证

选项 A：MCP 配置文件（推荐）

编辑或创建 ~/.mcp/configs.json：

{
	"confluence": {
		"environments": {
			"ATLASSIAN_SITE_NAME": "<你的站点名称>",
			"ATLASSIAN_USER_EMAIL": "<你的 Atlassian 邮箱>",
			"ATLASSIAN_API_TOKEN": "<你复制的 API 令牌>"
		}
	}
}

<你的站点名称>：你的 Confluence 站点名称（例如 mycompany 对应 mycompany.atlassian.net）。
<你的 Atlassian 邮箱>：你的 Atlassian 账户邮箱。
<你复制的 API 令牌>：第一步中获取的 API 令牌。

选项 B：环境变量

export ATLASSIAN_SITE_NAME="<你的站点名称>"
export ATLASSIAN_USER_EMAIL="<你的邮箱>"
export ATLASSIAN_API_TOKEN="<你的 API 令牌>"

第三步：安装并运行

使用 `npx` 快速开始

npx -y @aashari/mcp-server-atlassian-confluence ls-spaces

全局安装

npm install -g @aashari/mcp-server-atlassian-confluence
mcp-atlassian-confluence ls-spaces

第四步：连接到 AI 助手

配置你的 MCP 兼容客户端（如 Claude、Cursor AI）：

{
	"mcpServers": {
		"confluence": {
			"command": "npx",
			"args": ["-y", "@aashari/mcp-server-atlassian-confluence"]
		}
	}
}

MCP 工具

MCP 工具使用 snake_case 命名，camelCase 参数，并返回 Markdown 格式的响应。

conf_ls_spaces：列出可访问的 Confluence 空间（type：str opt，status：str opt，limit：num opt，cursor：str opt）。用途：查看可用空间。
conf_get_space：获取详细的空间信息（spaceKey：str req）。用途：访问空间内容和元数据。
conf_ls_pages：列出带有过滤条件的页面（spaceIds：str[] opt，spaceKeys：str[] opt，title：str opt，status：str[] opt，sort：str opt，limit：num opt，cursor：str opt）。用途：查找符合特定条件的页面。
conf_get_page：获取全面的页面内容（pageId：str req）。用途：以 Markdown 格式查看完整页面内容。
conf_ls_page_comments：列出页面上的评论（pageId：str req）。用途：阅读页面讨论。
conf_search：搜索 Confluence 内容（cql：str opt，query：str opt，title：str opt，spaceKey：str opt，labels：str[] opt，contentType：str opt，limit：num opt，cursor：str opt）。用途：查找特定内容。

MCP 工具示例（点击展开）

`conf_ls_spaces`

列出全局空间：

{ "type": "global", "status": "current", "limit": 10 }

`conf_get_space`

获取空间详情：

{ "spaceKey": "DEV" }

`conf_ls_pages`

按空间和标题列出页面：

{
	"spaceKeys": ["DEV"],
	"title": "API 文档",
	"status": ["current"],
	"sort": "-modified-date"
}

从多个空间列出页面：

{
	"spaceKeys": ["DEV", "HR", "MARKETING"],
	"limit": 15,
	"sort": "-modified-date"
}

`conf_get_page`

获取页面内容：

{ "pageId": "12345678" }

`conf_ls_page_comments`

列出页面评论：

{ "pageId": "12345678" }

`conf_search`

简单搜索：

{
	"query": "Q1 发布说明",
	"spaceKey": "PRODUCT",
	"contentType": "page",
	"limit": 5
}

高级 CQL 搜索：

{ "cql": "space = DEV AND label = api AND created >= '2023-01-01'" }

CLI 命令

CLI 命令使用 kebab-case。运行 --help 查看详情（例如 mcp-atlassian-confluence ls-spaces --help）。

ls-spaces：列出空间（--type，--status，--limit，--cursor）。例如：mcp-atlassian-confluence ls-spaces --type global。
get-space：获取空间详情（--space-key）。例如：mcp-atlassian-confluence get-space --space-key DEV。
ls-pages：列出页面（--space-keys，--title，--status，--sort，--limit，--cursor）。例如：mcp-atlassian-confluence ls-pages --space-keys DEV。
get-page：获取页面内容（--page-id）。例如：mcp-atlassian-confluence get-page --page-id 12345678。
ls-page-comments：列出评论（--page-id）。例如：mcp-atlassian-confluence ls-page-comments --page-id 12345678。
search：搜索内容（--cql，--query，--space-key，--label，--type，--limit，--cursor）。例如：mcp-atlassian-confluence search --query "security"。

CLI 命令示例（点击展开）

列出空间

列出全局空间：

mcp-atlassian-confluence ls-spaces --type global --status current --limit 10

获取空间

mcp-atlassian-confluence get-space --space-key DEV

列出页面

按多个空间键列出：

mcp-atlassian-confluence ls-pages --space-keys DEV HR MARKETING --limit 15 --sort "-modified-date"

带标题过滤：

mcp-atlassian-confluence ls-pages --space-keys DEV --title "API 文档" --status current

获取页面

mcp-atlassian-confluence get-page --page-id 12345678

列出页面评论

mcp-atlassian-confluence ls-page-comments --page-id 12345678

搜索

简单搜索：

mcp-atlassian-confluence search --query "安全最佳实践" --space-key DOCS --type page --limit 5

CQL 搜索：

mcp-atlassian-confluence search --cql "label = official-docs AND creator = currentUser()"

响应格式

所有响应均采用 Markdown 格式，包括：

标题：内容类型和名称。
内容：完整页面内容、搜索结果或项目列表。
元数据：创建者、日期、标签和其他相关信息。
分页：分页结果的导航信息。
链接：相关资源的引用（如适用）。

响应格式示例（点击展开）

空间列表响应

# Confluence 空间

显示 **5** 个全局空间（当前）

| 键 | 名称 | 描述 |
|---|---|---|
| [DEV](#) | 开发 | 工程和开发文档 |
| [HR](#) | 人力资源 | 员工政策和程序 |
| [MARKETING](#) | 市场营销 | 品牌指南和活动材料 |
| [PRODUCT](#) | 产品 | 产品规格和路线图 |
| [SALES](#) | 销售 | 销售流程和资源 |

*从 mycompany.atlassian.net 检索于 2025-05-19 14:22 UTC*

使用 `cursor: "next-page-token-123"` 查看更多空间。

页面内容响应

# API 认证指南

**空间：** [DEV](#)（开发）
**创建者：** Jane Smith 于 2025-04-01
**最后更新：** John Doe 于 2025-05-15
**标签：** api, security, authentication

## 概述

本文档介绍了我们 API 平台支持的认证方法。

## 认证方法

### OAuth 2.0

我们支持以下 OAuth 2.0 流程：

1. **授权码流程** - 用于 Web 应用程序
2. **客户端凭证流程** - 用于服务器到服务器
3. **隐式流程** - 仅用于旧版客户端

### API 密钥

支持静态 API 密钥，但由于安全限制，不建议用于生产环境：

| 密钥类型 | 使用场景 | 过期时间 |
|---|---|---|
| 开发 | 测试 | 30 天 |
| 生产 | 实时系统 | 90 天 |

## 实现示例

  import requests

  def get_oauth_token():
      return requests.post(
          'https://api.example.com/oauth/token',
          data={
              'client_id': 'YOUR_CLIENT_ID',
              'client_secret': 'YOUR_CLIENT_SECRET',
              'grant_type': 'client_credentials'
          }
      ).json()['access_token']

*从 mycompany.atlassian.net 检索于 2025-05-19 14:25 UTC*

开发

# 克隆仓库
git clone https://github.com/aashari/mcp-server-atlassian-confluence.git
cd mcp-server-atlassian-confluence

# 安装依赖
npm install

# 以开发模式运行
npm run dev:server

# 运行测试
npm test

贡献

欢迎贡献！请：

分叉仓库。
创建功能分支（git checkout -b feature/xyz）。
提交更改（git commit -m "添加 xyz 功能"）。
推送到分支（git push origin feature/xyz）。
提交拉取请求。

详情请参阅 CONTRIBUTING.md。

许可证

ISC 许可证