Dylangames MCP Chess Engine

🚀 國際象棋 ChessPal 使用說明

ChessPal 是一款基於 MCP 協議的國際象棋引擎，它支持通過 STDIO 或 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

✨ 主要特性

• 遊戲邏輯：實現標準國際象棋規則和變種玩法。
• 引擎適配：支持 Stockfish 引擎接口。
• 網絡協議：MCP 協議適配。
• 用戶界面：提供 REST API 和 SSE 接口。

📦 安裝指南

標準輸入輸出模式

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

SSE 模式

poetry run python -m chesspal.chesspal

💻 使用示例

基礎用法

# 標準輸入輸出模式啟動命令
poetry run python -m chesspal.chesspal --transport stdio

# SSE 模式啟動命令
poetry run python -m chesspal.chesspal

高級用法

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

以上是請求示例，可根據實際情況修改 fen 和 move_history 的值。

📚 詳細文檔

項目配置

引擎設置

{
  "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. 提交前需通過所有測試用例。

代碼審查

• 所有提交的代碼都需要經過至少一位維護者的審查。
• 每個 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 <new_version>
   poetry publish
   

發佈說明

生成 CHANGELOG.md 文件時需包含以下內容：

• 新功能列表。
• 已知問題。
• 修復內容。
• 升級注意事項。

文檔編寫

項目文檔包括：

• 使用手冊（中文）。
• 開發指南。
• API 文檔。
• 設計文檔。

📄 許可證

本項目遵循 MIT 許可證，具體內容請參考 LICENSE 文件。

如需更多信息，請訪問項目主頁或查閱相關文檔。