MCP Server Confluence Ts

🚀 MCP Confluence API プロジェクトドキュメント

MCPは、Confluenceとのインタラクションを行うためのツールです。空間情報の取得、ページ内容の取得、検索機能、ページの作成と更新などの操作をサポートしています。

🚀 クイックスタート

MCPを使用するには、まずNode.jsとnpmをインストールする必要があります。その後、以下のコマンドを実行してインストールします。

npm install mcp-confluence-api --save

✨ 主な機能

• 空間情報の取得
• ページ内容の取得
• 検索機能
• ページの作成と更新

📦 インストール

MCPを使用するには、Node.jsとnpmをインストールする必要があります。その後、以下のコマンドを実行してインストールします。

npm install mcp-confluence-api --save

📚 ドキュメント

設定

MCPは、Access Tokenとユーザー名・パスワードの2種類の認証方式をサポートしています。必要に応じていずれかを選択して設定してください。

サンプルコード

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');

セキュリティ上の推奨事項

1. できるだけAccess Tokenによる認証方式を使用してください。これがより安全です。
2. Access Tokenを定期的に更新してください。
3. 認証情報をコード内にハードコードしないでください。
4. .envファイルが.gitignoreに追加されていることを確認してください。
5. 本番環境では、環境変数または安全な設定管理システムを使用してください。
6. 2種類の認証方式を同時に設定した場合、システムはAccess Tokenを優先的に使用します。

注意事項

1. Access Tokenとユーザー名・パスワードの認証方式は、いずれか1つのみを選択できます。
2. 2種類の認証方式を同時に設定した場合、システムはAccess Tokenを優先的に使用します。
3. URLが正しく有効であることを確認してください。
4. APIのバージョンをConfluenceインスタンスのバージョンと一致させてください。

エラー処理

MCPはエラー処理機能を提供しており、以下のようにエラーをキャッチすることができます。

try {
  // 操作コード
} catch (error) {
  console.error('Error:', error);
}

貢献ガイド

コミュニティからの貢献を歓迎します！GitHubのリポジトリにアクセスして、問題やPRを投稿してください。

ライセンス

MCP Confluence APIオープンソースプロジェクトは、MITライセンスに準拠しています。