Dylangames MCP Chess Engine

🚀 国際チェス ChessPal の使用説明

ChessPalは、MCPプロトコルに基づく国際チェスエンジンで、STDIOまたはSSEモードでの通信をサポートしています。このプロジェクトには以下の機能モジュールが含まれています。

• ゲームロジック：標準的な国際チェスのルールとバリエーションの遊び方を実装
• エンジン適合：Stockfishエンジンインターフェースをサポート
• ネットワークプロトコル：MCPプロトコルの適合
• ユーザーインターフェース：REST APIとSSEインターフェースを提供

🚀 クイックスタート

環境の準備

1. Python 3.8以上をインストール
2. Poetry依存管理ツールをインストール
3. Stockfishエンジンをダウンロード（オプション）

プロジェクト構造

chesspal/
├── chesspal.py    # メインプログラムのエントリーポイント
├── engines/       # エンジン適合モジュール
│   └── stockfish.py    # Stockfishエンジンインターフェース
├── protocols/     # プロトコルの実装
│   └── mcp.py        # MCPプロトコルの適合
└── tests/         # テストケース
    ├── unit/       # 単体テスト
    │   └── test_chesspal.py
    └── integration/  # 統合テスト
        └── test_stockfish_engine.py

💻 使用例

基本的な使用法

標準入出力モード

poetry run python -m chesspal.chesspal --transport stdio

SSEモード

poetry run python -m chesspal.chesspal

📚 ドキュメント

プロジェクト設定

エンジン設定

{
  "engine": {
    "name": "stockfish",
    "path": "/usr/bin/stockfish"
  },
  "protocol": {
    "type": "mcp",
    "options": {}
  }
}

リクエスト例

{
  "fen": "r3k2r/p1ppqpb1/bn2pnp1/3PN3/1p2P3/2N2Q1p/PPPBBPPP/R3K2R w KQkq - 0 1",
  "move_history": []
}

依存関係の管理

新しい依存関係の追加

# 本番環境の依存関係
poetry add パッケージ名

# 開発環境の依存関係
poetry add --group dev パッケージ名

コード規約

このプロジェクトは以下の標準に従っています。

• すべての関数に型ヒントを追加
• PEP 8コーディング規約に従う
• Blackを使用してコードを整形
• flake8を使用してコードをチェック
• isortを使用してインポートの順序を管理

貢献ガイド

コミット規約

1. 各コミットには詳細なコミットメッセージを含める
2. ブランチ命名規則に従う：feature/新機能名 または bugfix/問題ID
3. コミット前にすべてのテストケースを通過させる

コードレビュー

• すべてのコミットされたコードは、少なくとも1人のメンテナによるレビューを受ける必要があります。
• 各Pull Requestには詳細な説明ドキュメントを含める必要があります。

テスト方法

単体テスト

poetry run pytest tests/unit/

統合テスト

poetry run pytest tests/integration/

カバレッジチェック

poetry run coverage run -m chesspal.chesspal && poetry run coverage report

プロジェクトのメンテナンス

バージョン管理

1. Semantic Versioningプロトコルを使用してバージョン管理を行う
2. リリースフローに従う：

   poetry bump --version <新しいバージョン>
   poetry publish
   

リリースノート

CHANGELOG.mdファイルを生成する際には、以下の内容を含める必要があります。

• 新機能のリスト
• 既知の問題
• 修正内容
• アップグレード時の注意事項

ドキュメントの作成

このプロジェクトのドキュメントには以下が含まれます。

• 使用マニュアル（日本語）
• 開発ガイド
• APIドキュメント
• 設計ドキュメント

📄 ライセンス

このプロジェクトはMITライセンスに従っており、詳細はLICENSEファイルを参照してください。

詳細な情報が必要な場合は、プロジェクトのホームページにアクセスするか、関連ドキュメントを参照してください。