Confluence文档生成服务

Atlassian MCP Server是一个通过Python API自动生成Confluence文档的服务,支持代码文档化、页面管理和内容更新。

  • by lucasmgraham2
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 lucasmgraham2/atlassian-confluence-mcp-server

使用说明

Atlassian MCP服务器

MCP服务器,用于使用官方Atlassian Python API从代码创建Confluence文档。

特性

  • 自动连接到Confluence(内置凭据)
  • 创建带有语法高亮显示的文档页面
  • 支持功能和文件级文档
  • 管理页面内容(创建、追加、替换、删除)
  • 列出空间并查找现有页面

设置

1.安装依赖项:

pip install -r requirements.txt

2.添加到MCP客户端配置中:

Q开发者:

  • 名称:Atlassian
  • 运输:stdio
  • 命令:py
  • 参数:\path\to\mcp\server\

对于Copilot(mcp.json):

{
	"servers": {
		"atlassian-confluence": {
			"type": "stdio",
			"command": "py",
			"args": ["Path\\To\\Atlassian-Confluence-MCP-Server\\atlassian_mcp_server.py"],
			"env": {}
		}
	},
	"inputs": []
}

使用示例

列出可用空间

提示: “Confluence有哪些可用空间?”

  • 用途 list_spaces 工具自动
  • 显示您可以在其中创建页面的所有空间

创建简单文档页面

提示: “在AUC空间中创建一个名为“用户身份验证系统”的Confluence页面,描述我们所有的用户身份验证细节”

  • 用途 create_page 工具
  • 创建内容部分以描述手头的主题
  • 创建带有语法高亮显示的格式化页面

创建详细的代码文档

提示: “在AUC空间中记录此登录函数-它通过检查数据库中的凭据来处理用户身份验证,并返回JWT令牌”

  • 用途 create_code_documentation 工具
  • 创建带有解释的详细文档
  • 非常适合特定功能或代码块

查找现有页面

提示: “在AUC空间中查找有关“身份验证”的页面”

  • 用途 find_page 工具
  • 在页面标题中搜索匹配项

向现有页面添加内容

提示: “将此新功能文档添加到页面ID 12345”

  • 用途 append_to_page 工具
  • 保留现有内容

更新页面内容

提示: “用第12345页上的新实现替换旧登录方法”

  • 用途 replace_content 工具
  • 查找并替换特定内容

真正的AI提示示例

与其使用JSON配置或任何复杂的提示,不如自然地说:

  • “告诉我可以使用哪些Confluence空间”
  • “在DEV空间中为此身份验证模块创建文档”
  • “记录此calculate_tax函数-它获取收入并退还所欠税款”
  • “将此错误处理代码添加到现有的API文档页”
  • “在TECH空间中查找有关数据库连接的任何页面”

可用工具

核心工具

  • list_spaces -显示可用汇流空间
  • create_page -创建基本文档页面
  • create_code_documentation -创建详细的代码文档

页面管理

  • get_pages -列出空间中的页面
  • find_page -按标题搜索页面
  • get_page_content -查看页面内容
  • append_to_page -向现有页面添加内容
  • replace_content -替换特定内容
  • remove_content -删除特定内容

配置

将.py文件中的这些值修改为您的实际凭据:

  • CONFLUENCE_URL
  • CONFLUENCE_USERNAME
  • CONFLUENCE_TOKEN

从以下位置获取API令牌:https://id.atlassian.com/manage-profile/security/api-tokens