Zentaoapi Integration Package

🚀 MCP-Zentao プロジェクトドキュメント

MCP-Zentaoは、禅道システムと深度統合されたツールで、タスク管理、Bugトラッキング、プロジェクト管理などの機能を提供し、チームの作業効率を向上させます。

🚀 クイックスタート

MCP-Zentaoをすぐに使い始めるには、以下の手順に従ってください。

1. インストールが完了したら、ターミナルで以下のコマンドを実行します。

npm start

2. ブラウザを開き、http://localhost:3000にアクセスします。
3. 画面の指示に従ってログインまたは登録し、MCP-Zentaoの使用を開始します。

✨ 主な機能

コア機能

• タスク管理：タスクの作成、表示、完了をサポートします。
• Bugトラッキング：Bugの報告、割り当て、解決機能を提供します。
• プロジェクト管理：チームの協力を支援し、プロジェクトの進捗を追跡します。
• テスト統合：複数のテストフレームワークとシームレスに統合します。

技術的特性

• APIサポート：RESTful APIインターフェースを介してデータをやり取りします。
• プラグインシステム：カスタムプラグインによる機能拡張をサポートします。
• UIカスタマイズ性：高度にカスタマイズ可能なユーザーインターフェースを提供し、さまざまなニーズに対応します。

📦 インストール

MCP-Zentaoをシステムにインストールするには、以下の手順に従ってください。

1. ダウンロード：MCP-Zentao公式ページから最新バージョンのパッケージをダウンロードします。
2. 解凍：ダウンロードした圧縮ファイルを任意のディレクトリに解凍します。
3. 環境設定：インストールガイドに従って、必要な環境変数と依存関係を設定します。
4. サービスの起動：起動スクリプトを実行して、MCP-Zentaoサービスを開始します。

💻 使用例

基本的な使用法

# 初回設定
npm install
npx mcp-zentao init
# 起動
npm start

高度な使用法

# 設定の更新
npx mcp-zentao init

📚 ドキュメント

設定ファイルの場所

デフォルトでは、設定ファイルは~/.config/mcp-zentao/config.jsonにあります。このファイルで禅道システムの接続情報を見つけたり変更したりできます。

環境変数の設定

MCP-Zentaoは環境変数を使用した設定をサポートしています。プロジェクトのルートディレクトリに.envファイルを作成し、以下の内容を追加してください。

NODE_ENV=development
PORT=3000
ZENTAO_URL=http://your-zentao-instance

依存関係の管理

npmまたはyarnを使用して依存関係を管理します。

npmを使用する場合

npm install

yarnを使用する場合

yarn install

APIドキュメント

クラス名とインターフェース

• クラス名：MCP-Zentao SDKの詳細を参照してください。
• インターフェース名：
  • Task：タスクオブジェクトを表します。
  • Bug：Bugオブジェクトを表します。
  • BugResolution：Bugの解決方法を表します。

サンプルコード

const { Task, Bug, BugResolution } = require('mcp-zentao');

// 新しいタスクを作成
const task = new Task({
    title: '完成用户故事',
    description: '实现新增功能模块'
});

// タスクを送信
task.submit().then(() => {
    console.log('任务已提交');
}).catch(error => {
    console.error('提交失败:', error);
});

🔧 技術詳細

開発環境の要件

• オペレーティングシステム：Linux、Windows、macOS
• Node.jsバージョン：>=14.0.0
• npmバージョン：>=6.0.0
• その他の依存関係：開発者ドキュメントを参照してください。

開発フロー

1. リポジトリをクローン

git clone https://github.com/your-repo/mcp-zentao.git
cd mcp-zentao

2. 依存関係をインストール

npm install

3. 開発サーバーを起動

npm run dev

4. テスト

npm test

📄 ライセンス

MCP-ZentaoはMIT Licenseに準拠しており、個人および商用利用が許可されています。詳細な条項を理解するために、ライセンス契約をよく読んでください。

注意事項

⚠️ 重要提示

• 互換性：禅道システムのバージョンがMCP-Zentaoと互換性があることを確認してください。
• データ同期：定期的にデータ同期の状態を確認し、データの損失を防いでください。
• 権限管理：ユーザー権限を適切に設定し、システムのセキュリティを確保してください。

特徴

他のプロジェクトとの違い

機能比較

利点

• 禅道に特化した設計：禅道システムと深度統合され、使い勝手が良い。
• 柔軟な設定：高度なカスタマイズをサポートし、さまざまなチームのニーズに対応。

コマンドラインツール

MCP-Zentaoはコマンドラインツールmcp-cliを提供しており、以下の操作が可能です。

• init：プロジェクトの初期化。
• start：サービスの起動。
• build：本番環境のビルド。
• test：テストケースの実行。

用語集

• 禅道：プロジェクトとタスク管理のための禅道システムを指します。

よくある質問

1. サービスが起動しない場合
   • ポートが使用中でないことを確認してください。
   • すべての依存関係が正しくインストールされていることを確認してください。
2. 禅道への接続に失敗した場合
   • 禅道システムのURL、ユーザー名、パスワードを確認してください。
   • 禅道システムが稼働中で、ネットワークが正常であることを確認してください。

貢献ガイド

コミュニティの貢献を歓迎します！開発への参加方法については、貢献者ドキュメントを参照してください。