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": ["chess-uci-mcp@latest", "/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]"

# Resync the packages:
uv sync --extra=dev

# Run tests
pytest

# Check code style
ruff check

Release process

uv build
uv-publish

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.1.tar.gz (8.0 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.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chess_uci_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6a3a2335fce9902b5308d232c683b5675f882c45bb428d1f9a3b31e59b752ad8
MD5 51606a96b9b4a77e92768eb2a6cdadf8
BLAKE2b-256 be50ad494ab920b7d549d4093c2811ea8cb03ecc42a496fa79655db12dc66001

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chess_uci_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 28f079330157fd15c3940f6e366eafc2db5f0d4df62baa757aa646e32e51470f
MD5 e84fb5ec35a289c2941f7c90d4c01bd4
BLAKE2b-256 27c4a3cf6ff3197102f254e25afef39d9d397d3956e855dc3b786486f7cfbed5

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