Dylangames MCP Chess Engine

🚀 ChessPal: A Chess Engine Usage Guide

ChessPal is a chess engine based on the MCP protocol, supporting communication via STDIO or SSE modes. The project encompasses the following functional modules:

• Game Logic: Implements standard chess rules and variant gameplay.
• Engine Adaptation: Supports the Stockfish engine interface.
• Network Protocol: Adapts to the MCP protocol.
• User Interface: Provides REST API and SSE interfaces.

🚀 Quick Start

Environment Preparation

1. Install Python 3.8+.
2. Install the Poetry dependency management tool.
3. Download the Stockfish engine (optional).

Project Structure

chesspal/
├── chesspal.py    # Main program entry
├── engines/       # Engine adaptation module
│   └── stockfish.py    # Stockfish engine interface
├── protocols/     # Protocol implementation
│   └── mcp.py        # MCP protocol adaptation
└── tests/         # Test cases
    ├── unit/       # Unit tests
    │   └── test_chesspal.py
    └── integration/  # Integration tests
        └── test_stockfish_engine.py

💻 Usage Examples

STDIO Mode

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

SSE Mode

poetry run python -m chesspal.chesspal

📚 Documentation

Engine Configuration

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

Request Example

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

📦 Installation

Adding New Dependencies

# Production dependencies
poetry add package_name

# Development dependencies
poetry add --group dev package_name

🔧 Technical Details

The project adheres to the following standards:

• Add type hints to all functions.
• Follow the PEP 8 coding convention.
• Use Black to format the code.
• Use flake8 for code inspection.
• Use isort to manage import order.

🤝 Contribution Guidelines

Commit Specification

1. Each commit should include detailed commit information.
2. Follow the branch naming convention: feature/new_feature_name or bugfix/issue_id.
3. Pass all test cases before submitting.

Code Review

• All submitted code must be reviewed by at least one maintainer.
• Each Pull Request must include detailed documentation.

🧪 Testing Methods

Unit Tests

poetry run pytest tests/unit/

Integration Tests

poetry run pytest tests/integration/

Coverage Check

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

🛠️ Project Maintenance

Version Control

1. Use the Semantic Versioning protocol for version management.
2. Follow the release process:

   poetry bump --version <new_version>
   poetry publish
   

Release Notes

When generating the CHANGELOG.md file, the following content should be included:

• List of new features
• Known issues
• Fixed content
• Upgrade notes

📝 Documentation Writing

The project documentation includes:

• User Manual (Chinese)
• Development Guide
• API Documentation
• Design Documentation

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific details.

For more information, please visit the project homepage or refer to the relevant documentation.