使用说明
汇流MCP
基于Go的模型上下文协议(MCP)服务器,用于将AI助手与Atlassian Confluence集成。该工具为通过标准化MCP与Confluence API交互提供了无缝界面,使人工智能模型能够搜索、检索、创建和更新Confluence内容。
特性
- 搜索Confluence页面和空间
- 获取页面详细信息和内容
- 创建新页面和空间
- 更新现有页面
- 管理页面权限和元数据
- 获取页面评论
- 列出空间
安装
安装Confluence MCP有几种方法:
选项1:从GitHub版本下载
- 访问 GitHub 发布 页
- 下载适用于您平台的二进制文件:
confluence-mcp_linux_amd64适用于Linuxconfluence-mcp_darwin_amd64适用于macOSconfluence-mcp_windows_amd64.exe对于Windows
- 使二进制文件可执行(Linux/macOS):
chmod +x confluence-mcp_* - 将其移动到您的PATH(Linux/macOS):
sudo mv confluence-mcp_* /usr/local/bin/confluence-mcp
选项2:去安装
go install github.com/nguyenvanduocit/confluence-mcp@latest
选项3:Docker
直接使用Docker
-
从GitHub容器注册表中提取预构建映像:
docker pull ghcr.io/nguyenvanduocit/confluence-mcp:latest -
或者在本地构建Docker镜像:
docker build -t confluence-mcp .
配置
环境变量
身份验证需要以下环境变量:
ATLASSIAN_HOST=your_confluence_host
ATLASSIAN_EMAIL=your_email
ATLASSIAN_TOKEN=your_token
您可以直接在环境变量中或通过 .env 本地开发文件。
运输方式
Confluence MCP支持两种传输方式:
1.标准I/O(stdio)-默认值
这是大多数MCP客户端(如Claude Desktop和Cursor)使用的默认传输方法。
2.流式HTTP服务器
对于基于HTTP的集成,您可以使用HTTP传输运行服务器 --http_port 旗帜。
用法示例
使用克劳德桌面/光标(stdio传输)
添加到MCP配置文件中:
{
"mcpServers": {
"confluence": {
"command": "/path/to/confluence-mcp",
"args": ["-env", "/path/to/.env"]
}
}
}
使用Docker(stdio传输)
{
"mcpServers": {
"confluence": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e", "ATLASSIAN_HOST=your_confluence_instance.atlassian.net",
"-e", "ATLASSIAN_EMAIL=your_email@example.com",
"-e", "ATLASSIAN_TOKEN=your_atlassian_api_token",
"ghcr.io/nguyenvanduocit/confluence-mcp:latest"
]
}
}
}
使用HTTP传输
对于基于HTTP的集成,请使用以下命令运行服务器:
confluence-mcp --http_port 8080 --env .env
这将在以下位置启动服务器 http://localhost:8080/mcp
或者使用Docker:
docker run -p 8080:8080 \
-e ATLASSIAN_HOST=your_confluence_instance.atlassian.net \
-e ATLASSIAN_EMAIL=your_email@example.com \
-e ATLASSIAN_TOKEN=your_atlassian_api_token \
ghcr.io/nguyenvanduocit/confluence-mcp:latest \
--http_port 8080
可用工具
search_page-使用CQL在Confluence中搜索页面get_page-获取Confluence页面内容和元数据create_page-创建新的Confluence页面update_page-更新现有Confluence页面get_comments-从Confluence页面获取评论list_spaces-列出汇流空间
CLI使用情况
除了MCP服务器之外, confluence-mcp 提供独立的CLI二进制文件(confluence-cli)用于直接终端使用——不需要MCP客户端。
安装
# Build locally
just install-cli
# Or with Go
go install github.com/nguyenvanduocit/confluence-mcp/cmd/confluence-cli@latest
快速开始
# Set credentials
export ATLASSIAN_HOST=your-instance.atlassian.net
export ATLASSIAN_EMAIL=you@example.com
export ATLASSIAN_TOKEN=your-api-token
# Or use a .env file
confluence-cli --env .env <command> [flags]
命令
| 命令 | 描述 |
|---|---|
search-page |
使用CQL搜索页面 |
get-page |
获取页面内容和元数据 |
create-page |
创建新页面 |
update-page |
更新现有页面 |
get-comments |
在页面上获取评论 |
list-spaces |
列出所有汇流空间 |
示例
# Search pages
confluence-cli search-page --query "space = DEV AND type = page"
# Get a page
confluence-cli get-page --id 123456
# Create a page
confluence-cli create-page --space DEV --title "My Page" --content "Hello World"
# Update a page
confluence-cli update-page --id 123456 --title "Updated Title" --content "New content"
# List spaces
confluence-cli list-spaces
# JSON output (pipe-friendly)
confluence-cli search-page --query "space = DEV" --output json | jq '.results[].title'
旗帜
每个命令都接受:
--env string--通往.env文件--output string--输出格式:text(默认)或json
贡献
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
许可证
此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件。
安装
自制(macOS/Linux)
brew install nguyenvanduocit/tap/confluence-mcp