Skip to main content

MCP server to connect to the chess engines using UCI protocol

Project description

chess-uci-mcp

An MCP bridge that provides an interface to UCI chess engines (such as Stockfish).

Dependencies

You need to have Python 3.10 or newer, and also uv/uvx installed.

Usage

To function, it requires an installed UCI-compatible chess engine, like Stockfish (has been tested with Stockfish 17).

In case of Stockfish, you can download it from https://stockfishchess.org/download/.

On macOS, you can use brew install stockfish.

You need to find out the path to your UCI-capable engine binary; for further example configuration, the path is e.g. /usr/local/bin/stockfish (which is default for Stockfish installed on macOS using Brew).

The further configuration should be done in your MCP setup; for Claude Desktop, this is the file claude_desktop_config.json (find it in Settings menu, Developer, then Edit Config).

The full path on different OSes

  • macOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%/Claude/claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

Add the following settings to your MCP configuration (depending on the way to run it you prefer):

Uvx (recommended)

Uvx is able to directly run the Python application by its name, ensuring all the dependencies, in a automatically-created virtual environment. This is the preferred way to run the chess-uci-mcp bridge.

Set up your MCP server configuration (e.g. Claude Desktop configuration) file as following:

"mcpServers": {
  "chess-uci-mcp": {
    "command": "uvx",
    "args": ["--from=git+https://github.com/AnglerfishChess/chess-uci-mcp", "chess-uci-mcp", "/usr/local/bin/stockfish"]
  }
}

Uv

Use it if you have the repository cloned locally and run from it:

"mcpServers": {
  "chess-uci-mcp": {
    "command": "uv",
    "args": ["run", "chess-uci-mcp", "/usr/local/bin/stockfish"]
  }
}

Available MCP Commands

The bridge provides the following MCP commands:

  1. analyze - Analyze a chess position specified by FEN string
  2. get_best_move - Get the best move for a chess position
  3. set_position - Set the current chess position
  4. engine_info - Get information about the chess engine

Development

# Clone the repository
git clone https://github.com/AnglerfishChess/chess-uci-mcp.git
# ... or
#    git clone git@github.com:AnglerfishChess/chess-uci-mcp.git

cd chess-uci-mcp

# Create a virtual environment
uv venv --python python3.10

# Activate the virtual environment
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate     # On Windows

# Install the package in development mode
#    uv pip install -e .
# or, with development dependencies
uv pip install -e ".[dev]"

# Run tests
pytest

# Check code style
ruff check

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chess_uci_mcp-0.1.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chess_uci_mcp-0.1.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file chess_uci_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: chess_uci_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.11

File hashes

Hashes for chess_uci_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3b7fde9bd61b052b46b7ada89077223f2734100a21d7257efa4937d61c147b96
MD5 082f0e39f7ef52c9bd4f9de2e14c1ca6
BLAKE2b-256 e7c6d01d6e78a82b0864f97b3ed787b232d044a330bfcca78d15ef25991d1b49

See more details on using hashes here.

File details

Details for the file chess_uci_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for chess_uci_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 74f13f65ab54a18ad644374f140f26764ac3f028b73a9b9a462e8ddf42a14d10
MD5 961c549e60a5b8d83489c8756fd13b0e
BLAKE2b-256 f48b931019cb1d7181964bd105360c957d816708a6a8395ece2fbdab5c4b3409

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page