使用说明
汇流MCP服务器
Atlassian Confluence的模型上下文协议(MCP)服务器。该服务器提供搜索、读取、创建和更新Confluence页面的工具,内置访问控制,可实现安全的AI交互。
特性
- 搜索:使用Confluence查询语言(CQL)查找页面,按允许的空格和特定页面ID自动过滤。
- 阅读:以纯文本(用于推理)和存储格式(HTML,用于编辑)检索页面内容。
- 创建:在白名单空间和特定父页面下创建新页面。自动应用
ai-managed标签。 - 更新:安全更新页面。强制页面必须具有
ai-managed或ai-generated标签可以修改。 - 智能合并:辅助工具,用于获取上下文以将更新合并到现有页面中。
- 带孩子:检索特定页面的直接子页面。当搜索不可靠时,可用于导航层次结构。
- 可配置的访问控制:权限在中定义
config.json,不是硬编码的。
安装
选项1:通过pip安装(推荐)
如果您在本地或从git repo安装了该包,则可以直接安装:
pip install .
选项2:通过紫外线安装(最快)
如果你使用 紫外线,您可以安装依赖项并高效运行项目。
uv pip install .
选项3:从源代码运行
- 克隆存储库。
- 安装依赖项:注:
pip install -r requirements.txtrequirements.txt是为了方便而提供的,但是pyproject.toml是真理的源泉。
配置
1.环境变量
服务器需要以下环境变量进行身份验证:
CONFLUENCE_BASE_URL:Confluence实例的基本URL(例如。,https://your-domain.atlassian.net/wiki).CONFLUENCE_EMAIL:您的Atlassian帐户电子邮件。CONFLUENCE_API_TOKEN:您的Atlassian API代币。
对于 代理,您还需要LLM密钥:
OPENAI_API_KEY,ANTHROPIC_API_KEY,或GOOGLE_API_KEY.
2.访问控制(config.json)
创建一个 config.json 您将运行服务器的目录中的文件。您可以复制 config.example.json 作为一个起点。
{
"allowed_spaces": ["AR", "ENG", "KB"],
"allowed_parents": {
"AR": ["2424881", "2490466"],
"ENG": ["223344"],
"KB": ["998877"]
}
}
- 允许的空间:AI可以访问的空格键列表。
- 允许租金:字典将空格键映射到页面ID列表。
- 为了创造:新页面可以 仅 被创建为这些ID的子项。
- 搜索:搜索结果仅限于 仅 这些ID。
服务器正在查找 config.json 按照以下顺序:
- 指定的路径
CONFLUENCE_MCP_CONFIG环境变量。 - 当前工作目录。
- 包目录(回退)。
用法
运行MCP服务器
标准:
confluence-mcp
紫外线:
uv run confluence-mcp
运行会话代理
该项目包括 Chainlit 连接到MCP服务器的代理。
使用启动器脚本(推荐):
./start_agent.sh
这将自动启动启用远程访问的代理。
手动启动(仅限本地访问):
chainlit run src/confluence_mcp/agent/app.py -w
手动启动远程访问:
chainlit run src/confluence_mcp/agent/app.py -w --host 0.0.0.0 --port 8000
紫外线:
uv run chainlit run src/confluence_mcp/agent/app.py -w --host 0.0.0.0 --port 8000
访问URL:
- 当地:
http://localhost:8000 - 远程:
http://<your-ip>:8000(例如。,http://192.168.0.179:8000)
特征:
- 🎤 语音输入(使用Google Gemini进行转录)
- 🔍 具有祖先过滤功能的智能搜索
- 📝 创建和更新Confluence页面
- 💬 自然语言接口
- 🎯 常见任务的启动提示
连接到MCP客户端
您可以将此服务器与任何兼容MCP的客户端(Claude Desktop、Cursor等)一起使用。
克劳德桌面(claude_desktop_config.json)
{
"mcpServers": {
"confluence": {
"command": "uv",
"args": ["run", "confluence-mcp"],
"env": {
"CONFLUENCE_BASE_URL": "https://your-domain.atlassian.net/wiki",
"CONFLUENCE_EMAIL": "user@example.com",
"CONFLUENCE_API_TOKEN": "your-api-token"
}
}
}
}
光标
- 首选 设置 > 主控程序.
- 点击 添加新的MCP服务器.
- 名字:
confluence(或任何你喜欢的名字)。 - 类型:
command. - 命令:
uv run confluence-mcp(确保您位于项目目录中,或提供以下内容的完整路径uv和项目)。 - 环境变量:添加您的
CONFLUENCE_...钥匙在这里。