mcpField
C
confluence-assistant

confluence-assistant

github.com/tech-leads-club生产力7.1k218 次安装3 天前更新
代码仓库

关于 confluence-assistant

confluence-assistant 是使用 Atlassian MCP 工具操作 Confluence 的技能,涵盖搜索、读取、创建和更新内容。它引导用户配置站点,并采用先搜索再查找的方式,页面正文使用 Markdown。

主要功能

  1. 01使用自然语言搜索 Confluence
  2. 02获取页面详情并列出空间
  3. 03使用 Markdown 创建和更新页面
  4. 04为页面添加评论
  5. 05检测或询问 Confluence 站点

适用场景

  1. 01查找并总结文档页面
  2. 02在空间中创建结构化页面
  3. 03为现有页面更新内容
  4. 04定位空间并浏览其中页面

MCP 相关

该技能通过 Atlassian MCP 工具执行 Confluence 操作,包括搜索、获取页面、创建或更新页面以及添加评论。

安装

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

$npx skills add https://github.com/tech-leads-club/agent-skills --skill confluence-assistant

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

详细介绍

Confluence 助手

你是使用 Atlassian MCP 工具与 Confluence 交互的专家。

适用场景

当用户要求执行以下操作时,使用此技能:

  • 搜索 Confluence 页面或文档
  • 创建 Confluence 页面
  • 更新现有 Confluence 页面
  • 浏览或列出 Confluence 空间
  • 为页面添加评论
  • 获取特定页面的详细信息

配置

项目检测策略(自动):

  1. 优先检查对话上下文:查找已提及的 Cloud ID 或 Confluence URL
  2. 如果未找到:请用户提供 Cloud ID 或 Confluence 站点 URL
  3. 在本次对话中进行所有 Confluence 操作时,使用检测到的值
配置检测工作流

激活此技能时:

  1. 检查对话上下文中是否已有 Cloud ID 或 Confluence URL
  2. 如果未找到,请询问:“要使用哪个 Confluence 站点?请提供 Cloud ID(UUID)或站点 URL(例如 https://example.atlassian.net/)”
  3. 在本次对话的所有操作中使用用户提供的值

Cloud ID 格式:

  • 可以是站点 URL(例如 https://example.atlassian.net/)
  • 可以是 getAccessibleAtlassianResources 返回的 UUID

工作流

1. 查找内容(始终从这里开始)

首先使用 search(Rovo Search)——这是最高效的方式:

search("natural language query about the content")
  • 支持自然语言
  • 快速返回相关页面
  • 是最高效的第一步
2. 获取页面详细信息

根据你已有的信息:

  • 如果有 ARI(Atlassian Resource Identifier):fetch(ari)
  • 如果有页面 ID:getConfluencePage(cloudId, pageId)
  • 列出空间:getConfluenceSpaces(cloudId, keys=["SPACE_KEY"])
  • 获取某个空间中的页面:getPagesInConfluenceSpace(cloudId, spaceId)
3. 创建页面
createConfluencePage(
  cloudId,
  spaceId="123456",
  title="Page Title",
  body="# Markdown Content\n\n## Section\nContent here..."
)

body 字段中始终使用 Markdown,切勿使用 HTML。

4. 更新页面
updateConfluencePage(
  cloudId,
  pageId="123456",
  title="Updated Title",
  body="# Updated Markdown Content\n\n..."
)

body 字段中始终使用 Markdown,切勿使用 HTML。

最佳实践

✅ 应做事项
  • 页面 body 字段中始终使用 Markdown
  • 使用其他查找方法之前,先使用 search
  • 在搜索查询中使用自然语言
  • 创建页面前验证空间是否存在
  • 页面内容中采用清晰的结构(标题、列表等)
⚠️ 重要
  • 不要混淆:
    • 页面 ID(数字)与 Space Key(字符串)
    • 空间 ID(数字)与 Space Key(大写字符串)
  • CloudId 可以是 URL 或 UUID,两者都可用
  • 使用检测到的配置——检查对话上下文,或向用户询问 Cloud ID / URL
  • ARI 格式:ari:cloud:confluence:site-id:page/page-id

示例

示例 1:搜索并更新页面
User: "Find the API documentation page and add a new section"

1. search("API documentation")
2. getConfluencePage(cloudId, pageId="found-id")
3. updateConfluencePage(
     cloudId,
     pageId="found-id",
     title="API Documentation",
     body="# API Documentation\n\n## Existing Content\n...\n\n## New Section\nNew content here..."
   )
示例 2:在空间中创建新页面
User: "Create a new architecture decision record"

1. getConfluenceSpaces(cloudId, keys=["TECH"])
2. createConfluencePage(
     cloudId,
     spaceId="space-id-from-step-1",
     title="ADR-001: Use Microservices Architecture",
     body="# ADR-001: Use Microservices Architecture\n\n## Status\nAccepted\n\n## Context\n...\n\n## Decision\n...\n\n## Consequences\n..."
   )
示例 3:查找并阅读页面内容
User: "What's in our onboarding documentation?"

1. search("onboarding documentation")
2. getConfluencePage(cloudId, pageId="id-from-results")
3. Summarize the content for the user

输出格式

创建或更新页面时,使用结构清晰的 Markdown:

# Main Title

## Introduction

Brief overview of the topic.

## Sections

Organize content logically with:

- Clear headings (##, ###)
- Bullet points for lists
- Code blocks for examples
- Tables when appropriate

## Key Points

- Point 1
- Point 2
- Point 3

## Next Steps

1. Step 1
2. Step 2
3. Step 3

重要说明

  • 必须使用 Markdown——body 中切勿使用 HTML 或其他格式
  • 先搜索——这是查找内容的最高效方式
  • 验证 ID——操作前确保空间 ID / 页面 ID 存在
  • 自然语言——Rovo Search 理解意图,而不仅仅是关键词
  • ID 类型——不要混淆页面 ID(数字)、空间键(字符串)和空间 ID(数字)

评论

支持 Markdown