Plane MCP Server

🚀 プラットフォーム MCP サーバー

プラットフォーム MCP は、Plane と連携するためのサーバー側プロトコルの実装です。このツールを使用することで、AI モデルは Model Context Protocol（MCP）を通じて Plane とやり取りし、プロジェクト内の問題の作成、更新、照会などの操作を実行できます。

🚀 クイックスタート

このセクションでは、プラットフォーム MCP サーバーの基本的な使い方を説明します。

✨ 主な機能

コア機能

1. 問題の作成

   • 問題のタイトルと説明を指定できます。
   • 優先度、状態、担当者を設定できます。

2. 問題の更新

   • 一部のフィールドの更新をサポートし、関係のないデータを上書きしないようにします。
   • 一括操作オプションを提供します。

3. 問題の照会

   • プロジェクト ID でのフィルタリングをサポートします。
   • 並べ替え方式（時間や優先度など）を指定できます。
   • 返される結果の数を制限でき、デフォルトは 50 です。

4. プロジェクトの一覧表示

   • 関連するすべてのプロジェクトの詳細情報を取得します。
   • プロジェクト名、ID、その他のメタデータが含まれます。

その他の機能

• RESTful API の設計原則に準拠しています。
• ミドルウェア拡張をサポートします。
• 詳細なエラー処理メカニズムを提供します。
• 組み込みのログ記録機能があります。

📦 インストール

クイックインストール

npm install plane-mcp-server

開発環境のインストール

npm install --save-dev plane-mcp-server

📚 ドキュメント

プロジェクトの概要

Plane MCP は、Model Context Protocol（MCP）に準拠した実装で、Plane プラットフォームとのやり取りに使用されます。このプロトコルを通じて、AI モデルは以下の操作を実行できます。

• 問題の作成：指定されたプロジェクトに新しい問題を作成します。
• 問題の更新：既存の問題の属性を変更します。
• 問題の照会：特定のプロジェクト内のすべての問題または単一の問題を検索します。
• プロジェクトの一覧表示：ユーザーのすべてのプロジェクトのリストを取得します。

💻 使用例

基本的な使用法

問題の作成

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const issue = await mcp.createIssue({
        title: '新機能開発',
        description: '新しいユーザー認証モジュールを実装する必要があります',
        priority: 'high',
        assignees: ['user-id-1', 'user-id-2']
    });

    console.log('新規作成された問題:', issue);
}

main().catch(console.error);

プロジェクトの照会

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const projects = await mcp.listProjects();
    console.log('すべてのプロジェクト:', projects);
}

main().catch(console.error);

🔧 開発ガイド

開発依存関係のインストール

npm install --save-dev typescript @types/node

開発サーバーの起動

npm run dev

🔧 テスト方法

MCP インスペクターを使用してテストします。

npx @modelcontextprotocol/inspector dist/index.js

🔧 サンプルの使用方法

Claude と連携したい場合、以下はいくつかのサンプルシナリオです。

1. "すべてのプロジェクトを表示してください"
2. "「新機能開発」プロジェクトに、説明が「新しいユーザー認証モジュールを実装する必要があります」の問題を作成してください"
3. "問題 ID 123 の優先度を「緊急」に更新してください"

🔧 貢献ガイド

コードのコミット規則

1. 各コミットには詳細なコミットメッセージを含める必要があります。
2. 新機能にはユニットテストを付ける必要があります。
3. コードスタイルを統一してください。

コミットの手順

git add .
git commit -m "新機能の追加：問題の優先度設定をサポート"
git push origin main

📄 ライセンス

このプロジェクトは MIT ライセンスに準拠しています。詳細は以下の通りです。

MIT License

Copyright (c) 年 作者名 <メールアドレス>

このソフトウェアおよびソースコードの使用、複製、変更、配布を無償で許可しますが、上記の著作権表示とこの許諾表示をすべてのコピーに含める必要があります。

DISCLAIMER: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

📞 お問い合わせ

質問や提案がある場合は、以下の方法でお問い合わせください。

• メール：contact@example.com
• GitHub：あなたの GitHub リンク

Plane MCP サーバーをご利用いただき、ありがとうございます！ さらなる支援が必要な場合は、いつでもドキュメントをご覧ください。