Atlassian Confluence MCP Server

by aashari
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Connects to Atlassian's platform to access Confluence data, requiring Atlassian site credentials (site name, email, API token) for authentication and data retrieval.

  • Enables access to Atlassian Confluence spaces, pages, and content with tools for searching content using CQL, listing spaces, getting space details, listing pages within spaces, and retrieving full page content.

Atlassian Confluence MCP 服务器

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


概述

什么是 MCP?

模型上下文协议 (MCP) 是一种开放标准,允许 AI 系统安全且上下文地与外部工具和数据源连接。

该服务器专门为 Confluence Cloud 实现 MCP,将您的 Confluence 数据与 AI 助手连接起来。

为什么要使用此服务器?

  • 最小输入,最大输出理念:您只需要像spaceKeypageId这样的简单标识符。每个工具都会返回全面的详细信息,无需额外的参数。
  • 完整的知识库访问:为您的 AI 助手提供对您的文档、wiki 和知识库内容的实时全面可见性。
  • 丰富的内容格式:所有页面内容都会自动从 Atlassian 文档格式转换为 Markdown,并带有适当的标题、表格、列表和其他格式元素。
  • 安全的本地身份验证:凭证永远不会存储在服务器中。服务器在本地运行,因此您的令牌永远不会离开您的计算机,并且您可以只请求所需的权限。
  • 直观的 Markdown 回复:所有回复均使用结构良好的 Markdown,具有一致的格式和导航链接,以提高可读性。

入门

先决条件

  • Node.js (>=18.x):下载
  • 可以访问 Confluence Cloud 的Atlassian 帐户

步骤 1:获取 Atlassian 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配置文件(推荐)

创建或编辑~/.mcp/configs.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.atlassian.net对应的是mycompany )。
  • <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 兼容的客户端以启动此服务器。

克劳德/光标配置:

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

此配置在运行时自动启动服务器。


工具

本节介绍将此服务器与 AI 助手配合使用时可用的 MCP 工具。请注意,MCP 工具使用snake_case -case) 命名工具名称,使用camelCase命名参数。

list_spaces

列出可用的 Confluence 空间并可选择过滤。

{}

或者:

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

“显示所有 Confluence 空间。”


get_space

获取特定空间的完整详细信息,包括主页信息。

{ "spaceKey": "DEV" }

“请告诉我有关 Confluence 中的 DEV 空间的信息。”


list_pages

列出一个或多个空间内的页面,并提供可选的过滤功能。

{ "spaceId": ["123456"] }

或者:

{ "status": ["current"], "query": "Project Plan" }

“显示空间 123456 中的当前页面。”


get_page

获取特定页面的完整内容和元数据。

{ "pageId": "12345678" }

“获取 Confluence 页面 12345678 的内容。”


使用 CQL(Confluence 查询语言)搜索 Confluence 内容。

{ "cql": "text ~ 'project plan'" }

或者:

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

“在 Confluence 中搜索有关项目计划的页面。”


命令行界面 (CLI)

CLI 使用 kebab-case 来表示命令(例如, list-spaces )和选项(例如, --space-key )。

使用npx快速使用

npx -y @aashari/mcp-server-atlassian-confluence list-spaces npx -y @aashari/mcp-server-atlassian-confluence get-page --page 12345678

全局安装

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

然后直接运行:

mcp-atlassian-confluence list-spaces

发现更多 CLI 选项

使用--help查看所有可用命令的标志和用法:

mcp-atlassian-confluence --help

或者获取特定命令的详细帮助:

mcp-atlassian-confluence get-space --help mcp-atlassian-confluence search --help mcp-atlassian-confluence list-pages --help

执照

ISC 许可证

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

模型上下文协议服务器使 Claude 等 AI 助手能够访问和搜索 Atlassian Confluence 内容,从而实现与您组织的知识库集成。

  1. Overview
    1. What is MCP?
    2. Why Use This Server?
  2. Getting Started
    1. Prerequisites
    2. Step 1: Get Your Atlassian API Token
    3. Step 2: Configure Credentials
    4. Step 3: Connect Your AI Assistant
  3. Tools
    1. list_spaces
    2. get_space
    3. list_pages
    4. get_page
    5. search
  4. Command-Line Interface (CLI)
    1. Quick Use with npx
    2. Install Globally
    3. Discover More CLI Options
  5. License
    ID: heolqwudyi