Atlassian

🚀 MCP Atlassian 説明ドキュメント

このMCPサーバーは、AIエージェントが標準インターフェースを通じてAtlassian製品（ConfluenceやJiraを含む）と相互作用できるようにします。

🚀 クイックスタート

このMCPサーバーを使用することで、AIエージェントはAtlassian製品とのやり取りをスムーズに行うことができます。以下に、主な機能を紹介します。

✨ 主な機能

• Confluence：コンテンツの検索、スペース情報の取得、特定のページの検索
• Jira：問題の検索、問題の詳細情報の取得、プロジェクトの一覧表示など

📦 インストール

前提条件

• Node.js (v16以上)
• npm または yarn
• AtlassianアカウントとAPIトークン
• Docker（コンテナ化デプロイ用、オプション）

標準インストール手順

1. リポジトリをクローンします。

   git clone https://github.com/yourusername/mcp-atlassian.git
   cd mcp-atlassian
   

2. 依存関係をインストールします。

   npm install
   # またはmakeコマンドを使用
   make install
   

3. ルートディレクトリに.envファイルを作成し、Atlassianの認証情報を追加します。

   ATLASSIAN_HOST=https://your-domain.atlassian.net
   ATLASSIAN_EMAIL=your-email@example.com
   ATLASSIAN_API_TOKEN=your-api-token
   

Dockerインストール手順

1. リポジトリをクローンします。

   git clone https://github.com/yourusername/mcp-atlassian.git
   cd mcp-atlassian
   

2. 上記の通り.envファイルを作成します。

3. Dockerでコンテナを構築して実行します。

   # Dockerイメージを構築
   make docker-build
   
   # Dockerコンテナを実行
   make docker-run
   
   # またはDocker Composeを使用
   make docker-compose
   

💻 使用例

サーバーの起動

# npmで起動
npm start

# makeコマンドを使用
make start

# Dockerで実行
make docker-run

起動後、MCPサーバーは標準入力を監視し、標準出力でリクエストに応答します。

利用可能なツール一覧

Confluenceツールセット

• search-confluence：CQLを使用してConfluence内のコンテンツを検索します。

  • パラメータ：query（文字列）

• get-confluence-space：特定のConfluenceスペースの情報を取得します。

  • パラメータ：spaceKey（文字列）

• get-confluence-content：IDを指定して特定のコンテンツを取得します。

  • パラメータ：contentId（文字列）

• get-confluence-pages：あるスペース内のすべてのページを取得します。

  • パラメータ：spaceKey（文字列）、limit（数値、オプション）

Jiraツールセット

• search-jira-issues：JQLを使用して問題を検索します。

  • パラメータ：jql（文字列）、maxResults（数値、オプション）

• get-jira-issue：キーワードを指定して特定の問題を取得します。

  • パラメータ：issueKey（文字列）

• get-jira-projects：すべてのプロジェクトを取得します。

  • パラメータ：なし

• get-jira-project：プロジェクトのキーワードを指定して特定のプロジェクトを取得します。

  • パラメータ：projectKey（文字列）

• get-jira-issues：問題の一覧を取得します。

  • パラメータ：なし

📚 ドキュメント

プロジェクト構造

プロジェクトのディレクトリ構造は以下の通りです。

mcp-atlassian/
├── src/          # ソースコードディレクトリ
│   ├── confluence.js    # Confluence関連の機能実装
│   └── jira.js         # Jira関連の機能実装
├── Makefile        # プロジェクトビルドファイル
└── .env.example    # .envファイルのサンプル

ビルドとテスト

1. npmを使用して開発を行います。

   npm run dev
   

2. プロジェクトをテストします。

   npm test
   

3. プロジェクトをパッケージ化します。

   npm run build
   

Makefileの使用方法

Makefileには以下のコマンドが用意されています。

• make install：依存関係をインストールします。
• make dev：開発サーバーを起動します。
• make build：本番環境用にビルドします。
• make test：テストケースを実行します。
• make docker-build：Dockerイメージを構築します。
• make docker-run：Dockerコンテナを実行します。

📄 ライセンス

このプロジェクトは[ライセンス名]ライセンスに従います。詳細は[ライセンスファイルのパス]を参照してください。

🔗 貢献ガイド

コミュニティからの貢献を歓迎します！何か質問や提案があれば、以下の方法でご連絡ください。

• GitHubリポジトリにIssueを投稿する
• 連絡先メールアドレスにメールを送信する
• リポジトリをフォークしてPull Requestを送信する

変更を加える前に、貢献規範ドキュメントをよくお読みください。