🚀 Atlassian 使用指南
本指南详细介绍了 Atlassian 相关工具的安装、配置和使用方法，帮助你快速上手并高效使用该工具。
🚀 快速开始
本工具提供了两种安装方式，你可以根据自己的需求选择合适的安装方法。安装完成后，通过简单的配置即可开始使用。
📦 安装指南
安装方法
方法一：使用 npm 安装
直接通过 npm 进行全局安装：
npm install -g @aashari/mcp-server-atlassian-confluence
验证是否安装成功：
mcp-atlassian-confluence --version
安装完成后，你就可以直接使用命令行工具了。
方法二：使用 npx 运行
如果你不想进行全局安装，也可以直接使用 npx 运行：
npx -y @aashari/mcp-server-atlassian-confluence
📚 详细文档
配置指南
环境变量配置
你需要设置以下环境变量：
ATLASSIAN_SITE_NAME：用于指定 Confluence 站点名称。ATLASSIAN_USER_EMAIL：指定用户邮箱。ATLASSIAN_API_TOKEN：指定 API 访问令牌。
示例如下：
ATLASSIAN_SITE_NAME="your-site-name" \
ATLASSIAN_USER_EMAIL="your-email@example.com" \
ATLASSIAN_API_TOKEN="your-api-token" \
mcp-atlassian-confluence list-spaces
配置文件方法
你还可以通过编辑 ~/.mcp/configs.json 文件进行配置，添加以下内容：
{
"aashari/mcp-server-atlassian-confluence": {
"command": "npx",
"args": ["-y", "@aashari/mcp-server-atlassian-confluence"]
}
}
工具使用说明
1. 列出空间
查看所有 Confluence 空间：
mcp-atlassian-confluence list-spaces
可选参数：
--type：指定空间类型（如 global）。--status：指定空间状态（如 current）。--limit：设置结果数量上限。
2. 获取特定空间信息
查看具体空间详情：
mcp-atlassian-confluence get-space --space your-space-name
3. 列出空间内的页面
获取某个空间下的所有页面：
mcp-atlassian-confluence list-pages --space-id your-space-id
4. 获取具体页面内容
查看特定页面的详细内容：
mcp-atlassian-confluence get-page --page your-page-id
5. 使用 CQL 进行搜索
通过自定义查询语句搜索内容：
mcp-atlassian-confluence search --cql "type=page AND text~your-search-text" --limit your-limit
📄 许可证
本项目采用 ISC 许可证。