article
README
🚀 Atlassian Confluence MCP 服务器
本项目提供了一个模型上下文协议(MCP)服务器,它就像一座桥梁,连接着人工智能助手(例如 Anthropic 的 Claude、Cursor AI 或其他兼容 MCP 的客户端)和您的 Atlassian Confluence 实例。借助该服务器,AI 能够安全地实时访问并与您的 Confluence 空间和页面进行交互。
🚀 快速开始
本服务器可让人工智能助手与 Atlassian Confluence 实例建立连接,实现安全的实时交互。以下为您介绍安装和使用的基本步骤:
安装与运行
- 通过 npm 全局安装命令行工具
npm install -g @aashari/mcp-server-atlassian-confluence
- 使用示例命令
mcp-atlassian-confluence --help
# 查看所有可用命令及其选项
mcp-atlassian-confluence list-spaces
# 列出所有 Confluence 空间
mcp-atlassian-confluence get-page --page-id 12345678
# 获取指定页面的内容
配置指南
步骤 1: 安装依赖
npm install @aashari/mcp-server-atlassian-confluence
步骤 2: 启动服务器
npx @aashari/mcp-server-atlassian-confluence start
✨ 主要特性
什么是 MCP?
模型上下文协议(MCP)是一项开放标准,它能让人工智能系统安全且有针对性地连接到外部工具和数据源。本服务器针对 Confluence Cloud 实现了 MCP,成功将您的 Confluence 数据与 AI 助手连接起来。
为什么使用此服务器?
- 最小输入,最大输出理念:仅需
spaceKey和pageId等简单标识符。每个工具都会返回全面详细的信息,无需额外标志。 - 完整的知识库访问:为您的 AI 助手提供对文档、维基和知识库内容的完全可见性,且内容实时可用。
- 丰富的格式化内容:所有页面内容会自动从 Atlassian 文档格式转换为 Markdown,包含适当的标题、表格、列表和其他格式元素。
- 安全本地认证:凭据不会存储在服务器中。该服务器在本地运行,您的令牌不会离开设备,并且您可以请求所需的权限。
- 直观的 Markdown 内容:所有页面内容以易于阅读和编辑的 Markdown 格式返回。
💻 使用示例
命令行接口(CLI)使用
使用 npx 快速运行
npx -y @aashari/mcp-server-atlassian-confluence list-spaces
npx -y @aashari/mcp-server-atlassian-confluence get-page --page 12345678
全局安装后使用
mcp-atlassian-confluence list-spaces
# 列出所有 Confluence 空间
📚 详细文档
工具接口(API)
以下是 MCP 服务器提供的主要工具及其用法:
1. list-spaces
列出所有可用的 Confluence 空间。
{
"spaces": [
{
"id": "123456",
"key": "MySpaceKey",
"name": "My Space Name"
}
]
}
2. get-page
获取指定页面的内容。
mcp-atlassian-confluence get-page --page-id 12345678
返回结果:
{
"id": "12345678",
"title": "My Page Title",
"content": "# My Page Heading\nThis is the content of my page."
}
3. search
使用 CQL 搜索 Confluence 内容。
mcp-atlassian-confluence search --cql "text ~ 'project plan'"
返回结果:
{
"results": [
{
"id": "12345679",
"title": "Project Plan Document",
"content": "This document outlines our project plan for Q3."
}
]
}
扫码联系在线客服