使用说明

项目简介

Confluence MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在充当AI助手（如Claude、Cursor AI等MCP客户端）与Atlassian Confluence之间的桥梁。它允许AI安全、实时地访问和操作您的Confluence知识库，从而增强AI助手处理Confluence数据的能力。

主要功能点

实时访问Confluence知识库: AI助手可以实时访问Confluence空间和页面内容。
结构化Markdown内容: Confluence页面内容自动转换为Markdown格式，包括标题、表格、列表等，方便AI理解和处理。
安全本地认证: 用户的Confluence API Token仅存储在本地，不会泄露到外部服务器。
工具化操作: 提供一系列预定义的工具，如列出空间、获取空间详情、列出页面、获取页面内容和搜索Confluence内容，供AI助手调用。
命令行界面 (CLI): 除了作为MCP服务器运行，还提供CLI工具，方便用户直接在命令行操作Confluence数据。

安装步骤

安装 Node.js: 确保您的系统已安装 Node.js (>=18.x)。您可以从 Node.js官网下载并安装。
获取 Atlassian API Token:
- 访问 Atlassian API Token管理页面。
- 点击 "Create API token" (创建API令牌)。
- 输入令牌标签 (例如: 'mcp-confluence-access')。
- 点击 "Create" (创建) 并 立即复制生成的API令牌。

配置凭据:

方法 A: MCP 配置文件 (推荐)

创建或编辑 '~/.mcp/configs.json' 文件，并添加以下JSON配置：

{
	"@aashari/mcp-server-atlassian-confluence": {
		"environments": {
			"ATLASSIAN_SITE_NAME": "<YOUR_SITE_NAME>",
			"ATLASSIAN_USER_EMAIL": "<YOUR_ATLASSIAN_EMAIL>",
			"ATLASSIAN_API_TOKEN": "<YOUR_COPIED_API_TOKEN>"
		}
	}
}

'<YOUR_SITE_NAME>': 您的Confluence站点名称 (例如 'mycompany'，如果您的Confluence地址是 'mycompany.atlassian.net')。
'<YOUR_ATLASSIAN_EMAIL>': 您的Atlassian账户邮箱。
'<YOUR_COPIED_API_TOKEN>': 您在步骤2中复制的API令牌。

方法 B: 环境变量

您也可以在运行服务器时直接通过环境变量传递凭据，例如：

ATLASSIAN_SITE_NAME="<YOUR_SITE_NAME>" \
ATLASSIAN_USER_EMAIL="<YOUR_EMAIL>" \
ATLASSIAN_API_TOKEN="<YOUR_API_TOKEN>" \
npx -y @aashari/mcp-server-atlassian-confluence

服务器配置

对于MCP客户端，您需要配置启动 Confluence MCP Server 的命令。以下是一个用于 Claude 或 Cursor AI 的配置示例：

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

'server name': 'aashari/mcp-server-atlassian-confluence' (服务器名称，用于MCP客户端识别)
'command': 'npx' (启动命令，这里使用 'npx' 运行 npm 包)
'args': '["-y", "@aashari/mcp-server-atlassian-confluence"]' (传递给 'npx' 的参数，用于执行 Confluence MCP Server 包)

将以上JSON配置添加到您的MCP客户端配置中，客户端即可自动启动并连接到 Confluence MCP Server。

基本使用方法

启动服务器: MCP客户端会自动根据配置启动服务器。如果您选择手动运行，可以使用以下命令：

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

AI助手调用工具: 在您的MCP客户端（如Claude 或 Cursor AI）中，您可以指示AI助手使用以下工具与Confluence进行交互：
- 'list_spaces': 列出Confluence空间。
- 'get_space': 获取指定空间详情。
- 'list_pages': 列出Confluence页面。
- 'get_page': 获取指定页面内容。
- 'search': 在Confluence中搜索内容 (使用CQL查询)。
例如，在Claude中，您可以提问：'"Show me all Confluence spaces using the tool list_spaces"'。AI助手会解析您的请求并调用相应的工具，返回Confluence数据。
使用 CLI 工具: 您也可以直接使用命令行工具操作Confluence。例如，列出空间可以使用命令：
```
npx -y @aashari/mcp-server-atlassian-confluence list-spaces
```
更多CLI命令和选项，请参考仓库README或使用 '--help' 命令查看帮助信息。

关键词