MCP Server Confluence Ts

🚀 MCP Confluence API 項目文檔

MCP 是一款專門用於與 Confluence 進行交互的實用工具。它功能強大，支持獲取空間信息、頁面內容、執行搜索操作，還能創建和更新頁面等，為用戶在 Confluence 平臺上的操作提供了極大便利。

🚀 快速開始

要使用 MCP，你需要先安裝 Node.js 和 npm，然後通過以下命令進行安裝：

npm install mcp-confluence-api --save

✨ 主要特性

• 支持兩種認證方式：Access Token 和用戶名密碼，滿足不同場景的安全需求。
• 提供豐富的操作接口，如獲取空間信息、頁面內容、搜索功能以及創建和更新頁面等。
• 具備錯誤處理功能，方便開發者捕獲和處理異常。

📦 安裝指南

要使用 MCP，請先安裝 Node.js 和 npm。然後通過以下命令安裝：

npm install mcp-confluence-api --save

💻 使用示例

基礎用法

配置

MCP 支持兩種認證方式：Access Token 和用戶名密碼。請根據需求選擇其中一種配置。

const ConfluenceService = require('mcp-confluence-api');

// 使用 Access Token 認證
const confluenceService = new ConfluenceService({
  url: 'https://your-instance.atlassian.com',
  accessToken: 'your_access_token'
});

// 或者使用用戶名密碼認證
const confluenceService = new ConfluenceService({
  url: 'https://your-instance.atlassian.com',
  username: 'your_username',
  password: 'your_password'
});

具體操作

1. 獲取空間信息

const space = await confluenceService.getSpace('SPACE_KEY');

2. 獲取頁面信息

const page = await confluenceService.getPage('PAGE_ID');

3. 通過 Pretty URL 獲取頁面

const page = await confluenceService.getPageByPrettyUrl('SPACE_KEY', 'PAGE_TITLE');

4. 創建頁面

const newPage = await confluenceService.createPage({
  spaceKey: 'SPACE_KEY',
  title: 'Page Title',
  content: 'Page Content',
  parentId: 'PARENT_PAGE_ID', // 可選
  representation: 'storage' // 可選，默認為 'storage'
});

5. 更新頁面

const updatedPage = await confluenceService.updatePage({
  id: 'PAGE_ID',
  title: 'Updated Title', // 可選
  content: 'Updated Content', // 可選
  version: 2, // 頁面版本號
  representation: 'storage' // 可選，默認為 'storage'
});

6. 搜索內容

const results = await confluenceService.searchContent('search query');

7. 獲取頁面詳細內容

const content = await confluenceService.getPageContent('PAGE_ID');

📚 詳細文檔

安全建議

⚠️ 重要提示

• 優先使用 Access Token 認證方式，這樣更安全。
• 定期輪換 Access Token。
• 不要在代碼中硬編碼認證信息。
• 確保 .env 文件已添加到 .gitignore 中。
• 在生產環境中使用環境變量或安全的配置管理系統。
• 如果同時配置了兩種認證方式，系統會優先使用 Access Token。

注意事項

⚠️ 重要提示

• Access Token 和用戶名密碼認證方式只能選擇其中一種。
• 如果同時配置了兩種認證方式，系統會優先使用 Access Token。
• 確保 URL 正確且有效。
• 保持 API 版本與 Confluence 實例版本一致。

錯誤處理

MCP 提供錯誤處理功能，可以通過以下方式捕獲錯誤：

try {
  // 操作代碼
} catch (error) {
  console.error('Error:', error);
}

貢獻指南

歡迎社區貢獻！請訪問 GitHub 地址 提交問題和 PR。

📄 許可證

MCP Confluence API 開源項目遵循 MIT 協議。