连接 AI 到您的关联知识库
通过将克洛德,Cursor AI,以及其他AI助手直接连接到你的聚合空间,页面和文档,来转变你如何获取和与团队的知识互动. 从您的知识库获取即时答案, 搜索您的全部空间, 并精简您的文档工作流程 .
你能做什么吗
- 问AI你的文件:"我们的API认证程序是什么?"
- 搜索所有空格:"寻找关于安全最佳做法的所有页面"
- 获取即时答案:"给我看看产品空间的最新发行说明"
- 获取团队知识:"我们远程工作的人力资源政策是什么
- 评论:"给我看看关于建筑文件的讨论"
- 创建并更新内容:"在DEV空间创建新页面"
完美为
- 开发者 需要迅速获得技术文件和API指南的人
- 产品管理员 搜索要求、规格和项目更新
- 人力资源小组 快速获取政策文件和雇员资源
- 支助小组 寻找解决问题的指南和知识库文章
- 谁都行 想要用自然语言与相交
快速启动
两分钟后起床跑道:
1. 获得你的影响力证书
生成组合 API 键 :
- 转到 地图集API 键
- 点击 创建 API 令牌
- 给它一个名字像 阿联酋助理
- 复制生成的令牌 立刻,你不会再看到它了
2. 立即尝试
# Set your credentials
export ATLASSIAN_SITE_NAME="your-company" # for your-company.atlassian.net
export ATLASSIAN_USER_EMAIL="[email protected]"
export ATLASSIAN_API_TOKEN="your_api_token"
# List your Confluence spaces
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces"
# Get details about a specific space
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces/123456"
# Get a page with JMESPath filtering
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/pages/789" --jq "{id: id, title: title, status: status}"
连接到 AI 助理
对于 Claude 桌面用户
将此添加到您的 Claude 配置文件( E)~/.claude/claude_desktop_config.json:
{
"mcpServers": {
"confluence": {
"command": "npx",
"args": ["-y", "@aashari/mcp-server-atlassian-confluence"],
"env": {
"ATLASSIAN_SITE_NAME": "your-company",
"ATLASSIAN_USER_EMAIL": "[email protected]",
"ATLASSIAN_API_TOKEN": "your_api_token"
}
}
}
}
重新启动克洛德桌面,你会看到状态栏中的聚合服务器.
其他助理助理
大多数AI助手支持MCP. 在全球安装服务器 :
npm install -g @aashari/mcp-server-atlassian-confluence
然后配置您的 AI 助手使用 STIO 传输的 MCP 服务器 .
选项: 配置文件
创建 ~/.mcp/configs.json 全系统配置:
{
"confluence": {
"environments": {
"ATLASSIAN_SITE_NAME": "your-company",
"ATLASSIAN_USER_EMAIL": "[email protected]",
"ATLASSIAN_API_TOKEN": "your_api_token"
}
}
}
替代配置密钥 : 系统还接受 "atlassian-confluence", (中文(简体) ), "@aashari/mcp-server-atlassian-confluence",或 "mcp-server-atlassian-confluence" 改为 "confluence"。 。 。 .
可用工具
这个 MCP 服务器提供了5个通用工具,可以访问任何 Copulation API 端点:
| 工具 | 说明 |
|---|---|
conf_get | 获取任何聚合 API 端点( 读取数据) |
conf_post | POST 到任何终点( 创建资源) |
conf_put | PUT 到任意终点(替换资源) |
conf_patch | PATCH 任意终点( 部分更新) |
conf_delete | DELETE 任意终点( 调走资源) |
常见 API 路径
空间 :
/wiki/api/v2/spaces- 列出所有空格/wiki/api/v2/spaces/{id}- 获取空间细节
页: 1
/wiki/api/v2/pages- 列表页(使用space-id要过滤的查询参数)/wiki/api/v2/pages/{id}- 获取页面细节/wiki/api/v2/pages/{id}/body- 获取页面正文(使用)body-format(第1款)/wiki/api/v2/pages/{id}/children- 获取儿童页面/wiki/api/v2/pages/{id}/labels- 获取页面标签
评论:
/wiki/api/v2/pages/{id}/footer-comments- 列表/添加页脚注释/wiki/api/v2/pages/{id}/inline-comments- 列表/添加内置注释/wiki/api/v2/footer-comments/{comment-id}- 获得/更新/删除评论
博客文章 :
/wiki/api/v2/blogposts- 列表博客文章/wiki/api/v2/blogposts/{id}- 获取博客文章
搜索 :
/wiki/rest/api/search- 搜索内容(使用)cql查询段落)
JMESPath 过滤
所有工具都支持可选 JMESPath (jq过滤以提取具体数据:
# Get just space names and keys
npx -y @aashari/mcp-server-atlassian-confluence get \
--path "/wiki/api/v2/spaces" \
--jq "results[].{id: id, key: key, name: name}"
# Get page title and status
npx -y @aashari/mcp-server-atlassian-confluence get \
--path "/wiki/api/v2/pages/123456" \
--jq "{id: id, title: title, status: status}"
现实世界实例
探索您的知识库
问你的人工智能助手:
- "把宇宙中所有的空间都找出来"
- "给我看看工程空间的细节"
- "我们产品空间里有什么页面?"
- "在营销空间找到最新页面"
搜索和查找信息
问你的人工智能助手:
- "搜索关于API认证的页面"
- "找到标题中包含"安全"的所有文件"
- "给我看贴有"开始"的页面"
- 搜索DEV空间内关于部署的内容
访问特定内容
问你的人工智能助手:
- "获取API认证指南页面内容"
- "给我看看登机清单文件"
- "我们的安保政策页面是什么?"
- "播放最新发行笔记"
创建并更新内容
问你的人工智能助手:
- 在 DEV 空间创建新页面,名为“ API 指南 ”
- "添加对架构文档的评论"
- "用新发布信息更新页面内容"
CLI 命令
CLI 镜像 MCP 直接终端访问的工具 :
# GET request
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces"
# GET with query parameters
npx -y @aashari/mcp-server-atlassian-confluence get \
--path "/wiki/api/v2/pages" \
--query-params '{"space-id": "123456", "limit": "10"}'
# POST request (create a page)
npx -y @aashari/mcp-server-atlassian-confluence post \
--path "/wiki/api/v2/pages" \
--body '{"spaceId": "123456", "status": "current", "title": "New Page", "body": {"representation": "storage", "value": "<p>Content here</p>"}}'
# POST request (add a comment)
npx -y @aashari/mcp-server-atlassian-confluence post \
--path "/wiki/api/v2/pages/789/footer-comments" \
--body '{"body": {"representation": "storage", "value": "<p>My comment</p>"}}'
# PUT request (update page - requires version increment)
npx -y @aashari/mcp-server-atlassian-confluence put \
--path "/wiki/api/v2/pages/789" \
--body '{"id": "789", "status": "current", "title": "Updated Title", "spaceId": "123456", "body": {"representation": "storage", "value": "<p>Updated content</p>"}, "version": {"number": 2}}'
# DELETE request
npx -y @aashari/mcp-server-atlassian-confluence delete \
--path "/wiki/api/v2/pages/789"
解决问题
"校正失败"或"403紫禁"
-
检查您的 API 调试权限数字 :
- 转到 地图集API 键
- 确定你的代币还在使用中, 并且还没有过期
-
校验您的站点名称格式数字 :
- 如果您的组合 URL 是
https://mycompany.atlassian.net - 你的网站名应该只是
mycompany
- 如果您的组合 URL 是
-
测试您的证书数字 :
npx -y @aashari/mcp-server-atlassian-confluence get --path "/wiki/api/v2/spaces?limit=1"
"未找到资源"或"404"
-
检查 API 路径数字 :
- 路径对大小写敏感
- 对空格和页面使用数字标识(不是密钥)
- 校验浏览器中存在的资源
-
验证访问权限数字 :
- 确保您可以访问浏览器中的空间/ 页面
- 一些内容可能仅限于某些用户
搜索时找不到结果
-
尝试不同的搜索术语数字 :
- 高级搜索使用 CQL 语法
- 尝试更广泛的搜索标准
-
检查 CQL 语法数字 :
- 在 Conference 的高级搜索中先验证您的 CQL
Claude 桌面整合问题
- 重新启动 Claude 桌面 更新配置文件后
- 验证配置文件位置数字 :
- 马可斯:
~/.claude/claude_desktop_config.json - 窗口 :
%APPDATA%\Claude\claude_desktop_config.json
- 马可斯:
获取帮助
如果你仍然有问题:
- 运行一个简单的测试命令来验证所有工作
- 检查 GitHub 问题 类似的问题
- 以错误消息创建新问题并设置细节
经常被问到的问题
我需要什么许可?
您的Atlassian账户需要:
- 访问聚合物 包含您想要查询的空格的适当权限
- API 令牌 拥有适当的许可(在创建时自动授予)
我能用这个和相干服务器吗?
目前,此工具只支持 相会云. 未来版本中可能添加聚合服务器/数据中心支持.
我该怎么找到我的网站名?
您的网站名称是您的聚合 URL 的第一部分 :
- URL :
https://mycompany.atlassian.net- > 站点名称:mycompany - URL :
https://acme-corp.atlassian.net- > 站点名称:acme-corp
人工智能助理是做什么工作的?
任何支持模式背景协议的AI助手:
- 克劳德桌面
- 光标AI
- 继续. dev
- 许多其他
我的数据安全吗?
没错! 此工具 :
- 完全运行在您的本地机器上
- 使用您自己的交汇证书
- 从不向第三方发送数据
- 只访问您允许它访问的内容
我能马上搜索所有空间吗?
没错! 使用 CQL 查询进行跨空间搜索 。 例如:
npx -y @aashari/mcp-server-atlassian-confluence get \
--path "/wiki/rest/api/search" \
--query-params '{"cql": "type=page AND text~\"API documentation\""}'
从 v2.x 迁移
3.0版本用5个通用的HTTP方法工具来取代8+特定工具. 如果你从v2.x升级:
在(v2.x)之前:
conf_ls_spaces, conf_get_space, conf_ls_pages, conf_get_page,
conf_search, conf_ls_comments, conf_add_comment, ...
在(v3.0)之后:
conf_get, conf_post, conf_put, conf_patch, conf_delete
移徙实例:
conf_ls_spaces- > (中文)conf_get有路径/wiki/api/v2/spacesconf_get_space- > (中文)conf_get有路径/wiki/api/v2/spaces/{id}conf_ls_pages- > (中文)conf_get有路径/wiki/api/v2/pages?space-id={id}conf_get_page- > (中文)conf_get有路径/wiki/api/v2/pages/{id}conf_search- > (中文)conf_get有路径/wiki/rest/api/search?cql=...conf_add_comment- > (中文)conf_post有路径/wiki/api/v2/pages/{id}/footer-comments
支助
需要帮忙吗? 如何获得援助:
- 检查上面的故障排除区域 - 涉及最常见的问题
- 访问 GitHub 仓库 文件和实例: github.com/aashari/mcp-server-atlassian-相交点
- 报告问题 时间 GitHub 问题
- 开始讨论 专题请求或一般问题
照顾希望将AI带入知识管理流程的团队.