mcpField
C
confluence

confluence

github.com/spillwavesolutions文档处理68362 次安装43 周前更新
代码仓库

关于 confluence

confluence 是用于通过 MCP 工具和实用脚本管理 Confluence 文档的 Claude Code 技能。它支持页面搜索与编辑、下载为 Markdown、上传大型或含图片文档、格式转换，以及 Git 到 Confluence 的同步。

主要功能

  1. 01搜索和管理 Confluence 页面
  2. 02将页面下载为 Markdown
  3. 03上传大型文档和图片
  4. 04转换 Markdown 与 Wiki Markup
  5. 05用 mark CLI 同步 Git 文档
  6. 06渲染 Mermaid 图表

适用场景

  1. 01将 Confluence 页面取回并在本地处理为 Markdown
  2. 02上传含附件的大型文档
  3. 03将 Git 管理的文档发布到 Confluence

MCP 相关

该技能通过 Atlassian MCP 服务搜索、读取页面并执行小型页面操作。大型上传和含图片文档则使用 REST API 脚本处理。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/spillwavesolutions/confluence-skill --skill confluence

安装后在 Claude Code 中输入/confluence确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

INSTALLATION.md
PARENT_RELATIONSHIP_GUIDE.md
QUICK_REFERENCE.md
README.md
examples/
.env.confluence.example
upload_example.md
page_ids.example.txt
sample-confluence-page.md
.env.example
references/
confluence_storage_format.md
conversion_guide.md
mark_tool_guide.md
image_handling_best_practices.md
troubleshooting_guide.md
wiki_markup_guide.md
scripts/
generate_mark_metadata.py
convert_markdown_to_wiki.py
confluence_auth.py
download_confluence.py
requirements.txt
mermaid_renderer.py
upload_confluence.py
render_mermaid.py
upload_confluence_v2.py

详细介绍

Confluence 管理技能

通过 Claude Code 管理 Confluence 文档：将页面下载为 Markdown、上传包含图片的大型文档、在不同格式之间转换，并集成 Mermaid/PlantUML 图表。

目录

快速决策矩阵

任务工具说明
阅读页面MCP 工具confluence_get_page、confluence_search
上传小型纯文本内容（<10KB）MCP 工具confluence_create_page、confluence_update_page
上传大型文档（>10KB）upload_confluence_v2.pyREST API，无大小限制
上传包含图片的文档upload_confluence_v2.py自动处理附件
从 Git 同步到 Confluencemark CLI最适合 CI/CD 工作流
将页面下载为 Markdowndownload_confluence.py转换宏并下载附件

MCP 大小限制

MCP 工具的上传大小有限制（10-20KB）。对于大型文档或包含图片的页面，请通过 upload_confluence_v2.py 使用 REST API：

# Upload large document
python3 ~/.claude/skills/confluence/scripts/upload_confluence_v2.py \
    document.md --id 780369923

# Dry-run preview
python3 ~/.claude/skills/confluence/scripts/upload_confluence_v2.py \
    document.md --id 780369923 --dry-run

MCP 适合阅读页面，但不适合上传大型内容。

前提条件

必需
  • Atlassian MCP 服务（mcp__atlassian-evinova），并配置 Confluence 凭据
可选
  • mark CLI：从 Git 同步到 Confluence（brew install kovetskiy/mark/mark）
  • Mermaid CLI：渲染图表（npm install -g @mermaid-js/mermaid-cli）

核心工作流

将页面下载为 Markdown
# Single page
python3 ~/.claude/skills/confluence/scripts/download_confluence.py 123456789

# With child pages
python3 ~/.claude/skills/confluence/scripts/download_confluence.py --download-children 123456789

# Custom output directory
python3 ~/.claude/skills/confluence/scripts/download_confluence.py --output-dir ./docs 123456789

详情请参阅下载指南。

上传包含图片的页面
  1. 先使用 design-doc-mermaid 或 plantuml 技能将图表转换为图片
  2. 使用标准 Markdown 引用图片：![Description](./images/diagram.png)
  3. 通过 REST API 上传：
python3 ~/.claude/skills/confluence/scripts/upload_confluence_v2.py \
    document.md --id PAGE_ID

详情请参阅图片处理最佳实践。

搜索 Confluence
mcp__atlassian-evinova__confluence_search({
  query: 'space = "DEV" AND text ~ "API"',
  limit: 10
})
创建/更新页面（小型文档）
// Create page
mcp__atlassian-evinova__confluence_create_page({
  space_key: "DEV",
  title: "API Documentation",
  content: "h1. Overview\n\nContent here...",
  content_format: "wiki"
})

// Update page
mcp__atlassian-evinova__confluence_update_page({
  page_id: "123456789",
  title: "Updated Title",
  content: "h1. New Content",
  version_comment: "Updated via Claude Code"
})
从 Git 同步（mark CLI）

向 Markdown 文件添加元数据：





# API Guide
Content...

同步到 Confluence：

mark -f documentation.md
mark --dry-run -f documentation.md  # Preview first

详情请参阅 mark 工具指南。

在不同格式之间转换

完整的转换矩阵请参阅转换指南。

快速参考：

MarkdownWiki 标记
# Headingh1. Heading
**bold***bold*
*italic*_italic_
`code`{{code}}
[text](url)[text|url]

参考文档

references/ 目录中的详细指南：

指南用途
Wiki 标记参考Confluence Wiki 标记的完整语法
转换指南Markdown 转换为 Wiki 标记的规则
存储格式Confluence XML 存储格式详情
图片处理图片、Mermaid、PlantUML 工作流
mark 工具指南使用 mark CLI 从 Git 同步到 Confluence
故障排除常见错误及解决方案

可用的 MCP 工具

工具描述
confluence_search使用 CQL 或文本搜索
confluence_get_page按 ID 或标题检索页面
confluence_create_page创建新页面
confluence_update_page更新现有页面
confluence_delete_page删除页面
confluence_get_page_children获取子页面
confluence_add_label为页面添加标签
confluence_get_labels获取页面标签
confluence_add_comment为页面添加评论
confluence_get_comments获取页面评论

实用脚本

脚本用途
scripts/upload_confluence_v2.py上传包含图片的大型文档
scripts/download_confluence.py将页面下载为 Markdown
scripts/convert_markdown_to_wiki.py将 Markdown 转换为 Wiki Markup
scripts/convert_wiki_to_markdown.py将 Wiki Markup 转换为 Markdown
scripts/render_mermaid.py渲染 Mermaid 图表

版本：2.1.0 | 最后更新：2025-01-21

评论

支持 Markdown