Atlassian Confluence MCP Server

Atlassian Confluence MCP Server

镜子 (jìng zi)

MCP-Mirror

开发者工具
访问服务器

README

Atlassian Confluence MCP 服务器

本项目提供了一个模型上下文协议 (MCP) 服务器，它充当 AI 助手（如 Anthropic 的 Claude、Cursor AI 或其他 MCP 兼容客户端）和您的 Atlassian Confluence 实例之间的桥梁。它允许 AI 安全地实时访问和交互您的 Confluence 空间和页面。

什么是 MCP 以及为什么要使用此服务器？

模型上下文协议 (MCP) 是一种开放标准，使 AI 模型能够安全地连接到外部工具和数据源。 此服务器专门为 Confluence 实现了 MCP。

优势：

  • 实时访问： 您的 AI 助手可以直接访问最新的 Confluence 内容。
  • 消除复制/粘贴： 无需在 Confluence 和您的 AI 助手之间手动传输信息。
  • 增强的 AI 功能： 使 AI 能够有上下文地搜索、总结、分析和引用您的 Confluence 文档。
  • 安全性： 您可以通过 API 令牌控制访问。 AI 通过服务器进行交互，敏感操作保持隔离。

接口理念：简单输入，丰富输出

此服务器遵循“最小接口，最大细节”的方法：

  1. 简单工具： 仅请求必要的标识符或过滤器（如 pageId、spaceKey、cql）。
  2. 丰富细节： 当您请求特定项目（如 get-page）时，服务器默认提供所有相关信息（内容、标签、链接等），而无需额外的标志。

可用工具

此 MCP 服务器为您的 AI 助手提供以下工具：

列出空间 (list-spaces)

目的： 发现可用的 Confluence 空间并找到它们的“键”（唯一标识符）。

使用场景： 您需要知道哪些空间存在，查找空间的键，或按类型/状态过滤空间。

对话示例： “显示所有 Confluence 空间。”

参数示例： {}（基本列表不需要参数）或 { type: "global", status: "current" }（用于过滤）。

获取空间 (get-space)

目的： 使用空间的键检索有关 特定 空间的详细信息。 包括主页内容片段。

使用场景： 您知道空间键（例如，“DEV”）并且需要其完整详细信息、标签或主页概述。

对话示例： “告诉我关于 Confluence 中 'DEV' 空间的信息。”

参数示例： { spaceKey: "DEV" }

列出页面 (list-pages)

目的： 列出特定空间（使用数字空间 ID）或整个实例中的页面，并提供过滤选项。

使用场景： 您需要在已知空间中查找页面（需要数字 ID），按状态过滤，或对标题/标签进行简单的文本搜索。

对话示例： “显示空间 ID 123456 中的当前页面。”（如果您只知道键，请先使用 list-spaces）。

参数示例： { spaceId: ["123456"] } 或 { status: ["archived"], query: "Meeting Notes" }。

获取页面 (get-page)

目的： 使用页面的数字 ID 检索 特定 页面的完整内容（以 Markdown 格式）和元数据。

使用场景： 您知道页面的数字 ID（通过 list-pages 或 search 找到）并且需要读取、分析或总结其内容。

对话示例： “获取 Confluence 页面 ID 12345678 的内容。”

参数示例： { pageId: "12345678" }

搜索 (search)

目的： 使用 CQL（Confluence 查询语言）在 Confluence 内容（页面、博客、附件）中执行强大的搜索。

使用场景： 您需要涉及多个条件、全文搜索或按标签、日期、贡献者等过滤的复杂搜索。

对话示例： “在 Confluence 中搜索过去一周创建的、标记为 'meeting-notes' 的页面。”

参数示例： { cql: "label = meeting-notes AND created > -7d" }

前提条件

  • Node.js 和 npm： 确保您已安装 Node.js（包括 npm）。 从 nodejs.org 下载。
  • Atlassian 帐户： 一个有效的 Atlassian 帐户，可以访问您要连接的 Confluence 实例。

快速入门指南

按照以下步骤将您的 AI 助手连接到 Confluence：

步骤 1：获取您的 Atlassian API 令牌

重要提示： 将您的 API 令牌视为密码。 不要共享它或将其提交到版本控制。

  1. 转到您的 Atlassian API 令牌管理页面： https://id.atlassian.com/manage-profile/security/api-tokens
  2. 单击 创建 API 令牌。
  3. 给它一个描述性的 标签（例如，mcp-confluence-access）。
  4. 单击 创建。
  5. 立即复制生成的 API 令牌。 您将无法再次看到它。 安全地存储它。

步骤 2：配置服务器凭据

选择以下方法之一：

方法 A：全局 MCP 配置文件（推荐）

这可以使凭据分开并有条理。

  1. 创建目录（如果需要）：~/.mcp/

  2. 创建/编辑文件： ~/.mcp/configs.json

  3. 添加配置： 粘贴以下 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 对于 mycompany.atlassian.net）。
    • <YOUR_ATLASSIAN_EMAIL>：您的 Atlassian 帐户电子邮件。
    • <YOUR_COPIED_API_TOKEN>：来自步骤 1 的 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

步骤 3：连接您的 AI 助手

配置您的 MCP 客户端（Claude Desktop、Cursor 等）以运行此服务器。

Claude Desktop

  1. 打开设置（齿轮图标）> 编辑配置。

  2. 添加或合并到 mcpServers：

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

  3. 保存并重启 Claude Desktop。

  4. 验证： 单击“工具”（锤子）图标； 应列出 Confluence 工具。

Cursor AI

  1. 命令面板 (Cmd+Shift+P / Ctrl+Shift+P) > Cursor 设置 > MCP。
  2. 单击 + 添加新的 MCP 服务器。
  3. 输入：
    • 名称：aashari/mcp-server-atlassian-confluence
    • 类型：command
    • 命令：npx -y @aashari/mcp-server-atlassian-confluence
  4. 单击 添加。
  5. 验证： 等待服务器名称旁边的指示器变为绿色。

步骤 4：使用工具

您现在可以向您的 AI 助手询问与您的 Confluence 实例相关的问题：

  • “列出 Confluence 空间。”
  • “使用 CQL 搜索 Confluence：label = meeting-notes AND created > -7d”
  • “获取 Confluence 页面 ID 12345678 的内容。”
  • “总结 DEV 空间中的 'API 指南' 页面。”（您可能需要先使用 search 或 list-pages 找到页面 ID）。

用作命令行工具 (CLI)

您也可以直接从终端使用此软件包：

使用 npx 快速使用

无需安装 - 使用 npx 直接运行：

# 列出空间
npx -y @aashari/mcp-server-atlassian-confluence list-spaces

# 获取特定页面
npx -y @aashari/mcp-server-atlassian-confluence get-page --page 123456

# 搜索内容
npx -y @aashari/mcp-server-atlassian-confluence search --cql "type=page AND text~API" --limit 10

全局安装

为了频繁使用，您可以将软件包全局安装在您的系统上：

  1. 使用 npm 全局安装：

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

  2. 通过检查版本来验证安装：

    mcp-atlassian-confluence --version

  3. 使用命令，无需 npx 前缀：

    # 列出空间
mcp-atlassian-confluence list-spaces

# 列出带有过滤的空间
mcp-atlassian-confluence list-spaces --type global --status current --limit 10

# 获取空间详细信息
mcp-atlassian-confluence get-space --space DEV

# 列出空间中的页面
mcp-atlassian-confluence list-pages --space-id 12345

# 获取页面内容
mcp-atlassian-confluence get-page --page 123456

# 使用 CQL 搜索
mcp-atlassian-confluence search --cql "type=page AND text~API" --limit 10

使用全局安装进行配置

全局安装后，您仍然可以使用相同的配置方法：

  1. 使用环境变量：

    ATLASSIAN_SITE_NAME="<YOUR_SITE_NAME>" \
ATLASSIAN_USER_EMAIL="<YOUR_EMAIL>" \
ATLASSIAN_API_TOKEN="<YOUR_API_TOKEN>" \
mcp-atlassian-confluence list-spaces

  2. 使用全局 MCP 配置文件（推荐）： 按照快速入门指南中的说明设置 ~/.mcp/configs.json 文件。

许可证

ISC

推荐服务器

Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器，它使大型语言模型能够通过结构化的可访问性快照与网页进行交互，而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具，可以从自然语言描述生成现代化的用户界面组件，并与流行的集成开发环境（IDE）集成，从而简化用户界面开发流程。

官方
精选
本地
TypeScript
MCP Package Docs Server

MCP Package Docs Server

促进大型语言模型高效访问和获取 Go、Python 和 NPM 包的结构化文档，通过多语言支持和性能优化来增强软件开发。

精选
本地
TypeScript
Claude Code MCP

Claude Code MCP

一个实现了 Claude Code 作为模型上下文协议（Model Context Protocol, MCP）服务器的方案，它可以通过标准化的 MCP 接口来使用 Claude 的软件工程能力（代码生成、编辑、审查和文件操作）。

精选
本地
JavaScript
@kazuph/mcp-taskmanager

@kazuph/mcp-taskmanager

用于任务管理的模型上下文协议服务器。它允许 Claude Desktop（或任何 MCP 客户端）在基于队列的系统中管理和执行任务。

精选
本地
JavaScript
mermaid-mcp-server

mermaid-mcp-server

一个模型上下文协议 (MCP) 服务器，用于将 Mermaid 图表转换为 PNG 图像。

精选
JavaScript
Jira-Context-MCP

Jira-Context-MCP

MCP 服务器向 AI 编码助手（如 Cursor）提供 Jira 工单信息。

精选
TypeScript
Linear MCP Server

Linear MCP Server

一个模型上下文协议（Model Context Protocol）服务器，它与 Linear 的问题跟踪系统集成，允许大型语言模型（LLM）通过自然语言交互来创建、更新、搜索和评论 Linear 问题。

精选
JavaScript
Sequential Thinking MCP Server

Sequential Thinking MCP Server

这个服务器通过将复杂问题分解为顺序步骤来促进结构化的问题解决，支持修订，并通过完整的 MCP 集成来实现多条解决方案路径。

精选
Python
Curri MCP Server

Curri MCP Server

通过管理文本笔记、提供笔记创建工具以及使用结构化提示生成摘要，从而实现与 Curri API 的交互。

官方
本地
JavaScript