Esa

🚀 esa MCP サーバー

このサーバーは、Esa とのやり取りを行うための MCP（Middleware Component Protocol）サーバーです。コマンドラインやその他のツールを通じて、Esa の機能と統合することができます。例えば、プロジェクトの作成、更新、削除、コメントの管理、チームメンバーの管理などが可能です。

🚀 クイックスタート

esa MCP サーバーを使用するには、まずインストールと設定を行う必要があります。以下の手順に従って進めてください。

✨ 主な機能

esa MCP サーバーには、以下のような機能があります。

• プロジェクト関連：プロジェクトの一覧取得、詳細情報取得、新規作成、更新、削除が可能です。
• コメント関連：コメントの一覧取得、詳細情報取得、新規作成ができます。
• チームメンバー関連：チームメンバーの一覧取得、詳細情報取得が可能です。

📦 インストール

環境要件

• オペレーティングシステム：POSIX.1 - 2008 標準をサポートするオペレーティングシステム（Linux、macOS など）
• ソフトウェアバージョン：
  • Node.js: v8 以上
  • npm: 5.6.0 以上

インストール手順

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

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

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

npm install

3. 環境変数を設定します。
   • .env ファイルを作成または編集します。

     ESA_TOKEN=your_token_here
     ESA_TEAM_ID=your_team_id_here
     

4. サーバーを起動します。

npm start

💻 使用例

基本的な使用法

新しいプロジェクトを作成する

# 「My New Project」という名前の公開プロジェクトを作成する
curl --location 'http://localhost:3000/api/projects' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My New Project",
    "description": "A new project for our team.",
    "public": true
}'

プロジェクト情報を更新する

# プロジェクト ID 123 の名前と説明を更新する
curl --location 'http://localhost:3000/api/projects/123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Updated Project Name",
    "description": "This is an updated description."
}'

プロジェクトのコメントを取得する

# プロジェクト ID 456 のすべてのコメントを取得する
curl --location 'http://localhost:3000/api/projects/456/comments' \
--header 'Content-Type: application/json'

📚 ドキュメント

機能モジュール

プロジェクト関連

1. esa_list_projects - チーム内のすべてのプロジェクトを取得します。 入力パラメータ：
   • page (number, オプション)：取得するページ番号。
   • per_page (number, オプション)：1 ページに表示する結果の数（最大 100）。
2. esa_get_project - 特定のプロジェクトの詳細情報を取得します。 入力パラメータ：
   • project_id (string, 必須)：取得するプロジェクトの ID。
   • include (string, オプション)：関連付けるデータを指定します（例："members"、"comments"）。
3. esa_create_project - 新しいプロジェクトを作成します。 入力パラメータ：
   • name (string, 必須)：プロジェクトの名前。
   • description (string, オプション)：プロジェクトの説明。
   • public (boolean, オプション)：プロジェクトを公開するかどうか。デフォルトは false。
4. esa_update_project - 既存のプロジェクトの情報を更新します。 入力パラメータ：
   • project_id (string, 必須)：更新するプロジェクトの ID。
   • name (string, オプション)：新しいプロジェクトの名前。
   • description (string, オプション)：新しいプロジェクトの説明。
   • public (boolean, オプション)：プロジェクトを公開するかどうかのフラグ。
5. esa_delete_project - 特定のプロジェクトを削除します。 入力パラメータ：
   • project_id (string, 必須)：削除するプロジェクトの ID。

コメント関連

1. esa_list_comments - プロジェクト内のすべてのコメントを取得します。 入力パラメータ：
   • project_id (number, 必須)：コメントを取得するプロジェクトの ID。
   • page (number, オプション)：ページ番号。
   • per_page (number, オプション)：1 ページに表示する結果の数（最大 100）。
2. esa_get_comment - 特定のコメントの詳細情報を取得します。 入力パラメータ：
   • comment_id (string, 必須)：取得するコメントの ID。
   • include (string, オプション)：関連付けるデータを指定します（例："project"、"author"）。
3. esa_create_comment - 新しいプロジェクトコメントを作成します。 入力パラメータ：
   • project_id (number, 必須)：コメントするプロジェクトの ID。
   • body (string, 必須)：コメントの内容（Markdown 形式をサポート）。
   • author (string, オプション)：コメントの作者のスクリーン名。

チームメンバー関連

1. esa_get_members - チーム内のすべてのメンバーを取得します。 入力パラメータ：
   • page (number, オプション)：ページ番号。
   • per_page (number, オプション)：1 ページに表示する結果の数（最大 100）。
2. esa_get_member - 特定のチームメンバーの詳細情報を取得します。 入力パラメータ：
   • screen_name_or_email (string, 必須)：取得するメンバーのスクリーン名またはメールアドレス。

エラー処理

ステータスコードの説明

• 200 OK - リクエストが成功しました。
• 401 Unauthorized - 認証されていないか、トークンが無効です。
• 404 Not Found - リソースが見つかりません。
• 500 Internal Server Error - サーバー内部エラーです。

一般的なエラーシナリオ

1. 認証失敗

   # ステータスコード 401 と以下の内容が返されます。
   {
     "error": "Unauthorized",
     "message": "Invalid token provided."
   }
   

2. リソースが見つからない

   # ステータスコード 404 と以下の内容が返されます。
   {
     "error": "Not Found",
     "message": "Project with ID 123 not found."
   }
   

📄 ライセンス

本プロジェクトのライセンス情報は提供されていません。

ヘルプとサポート

• ドキュメント：esa-mcp ドキュメント
• サポート：support@yourdomain.com にお問い合わせください。