Aashari MCP Server Atlassian Confluence

🚀 Atlassian 使用指南

本指南詳細介紹了 Atlassian 相關工具的安裝、配置、使用方法，幫助你高效利用該工具進行 Confluence 空間和頁面的管理。

🚀 快速開始

你可以按照下面的步驟快速安裝和配置 Atlassian 工具，開啟使用之旅。

📦 安裝指南

方法一：使用 npm 安裝

直接通過 npm 進行全局安裝：

npm install -g @aashari/mcp-server-atlassian-confluence

驗證是否安裝成功：

mcp-atlassian-confluence --version

安裝完成後，即可直接使用命令行工具。

方法二：使用 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 許可證。