A generic MCTS framework driven by an external AI agent.
Project description
MCTS-Gen: A Generic MCTS Framework
This project provides a generic Monte Carlo Tree Search (MCTS) framework. Its core concept is the replacement of the Genetic Programming (GP) engine from chess-ant with a modern AI agent. While inspired by AlphaZero, it uses a simpler, decoupled approach: the standard UCT algorithm is augmented by an external AI agent that provides policy and value predictions.
Features
- AI-Augmented UCT: Utilizes the standard UCT algorithm. The AI agent enhances the search by providing value predictions and, most importantly, by performing Policy Pruning—narrowing the search space by supplying a pre-filtered list of promising moves.
- AI Agent Integration: Exposes the MCTS engine as a set of tools, enabling seamless integration with AI agents like the Gemini CLI.
- Extensible Game Logic: Easily add support for new games by creating a new game state module.
- Optional Dependencies: Install support for specific games on demand (e.g.,
pip install mcts-gen[shogi]).
Quickstart
1. Installation
Standard Installation
The core package can be installed directly using pip:
pip install mcts-gen
Installation with Game-Specific Dependencies
To include support for specific games, you can install optional dependencies.
-
For Shogi support:
pip install mcts-gen[shogi]
This installs the
python-shogilibrary. -
For Chess support:
pip install mcts-gen[chess]
This installs the
python-chesslibrary. -
For Ligand Generation support:
pip install mcts-gen[ligand]
This installs
rdkitandpandasfor de novo ligand design capabilities.Additionally, this feature requires the external tool
fpocketfor identifying protein binding pockets. It can be installed on Debian/Ubuntu systems using snap:sudo snap install fpocket
2. Server Setup for Gemini CLI
To allow the Gemini agent to use the MCTS-Gen tools, you must register the server in your settings.json file. This allows the Gemini CLI to automatically manage the server process and provide the necessary context files.
Note on v0.0.2+: As of version 0.0.2, the core agent instructions are built-in. Specifying a context file is no longer required for standard operation. Only configure the context block if you wish to provide additional instructions to the agent.
Create or update your settings.json file with the following configuration:
{
"context": {
"fileName": [
"src/mcts_gen/AGENTS.md",
"GEMINI.md"
]
},
"mcpServers": {
"mcts_gen_simulator_server": {
"command": "python",
"args": [
"-m",
"mcts_gen.fastmcp_server"
]
}
}
}
Note: The context block tells the Gemini CLI to load AGENTS.md (and GEMINI.md if it exists), which is crucial for the agent to understand how to use the tools.
You can place this settings.json file in one of two locations:
- Project-Specific:
./.gemini/settings.json(inside this project directory) - Global:
~/.gemini/settings.json(in your home directory)
For an alternative setup method using the fastmcp command-line tool, please see the official guide:
Installation with uv (Recommended)
For a faster and more modern package management experience, we recommend using uv.
-
Install
pipxanduv:# Install pipx (a tool to install and run Python applications in isolated environments) sudo apt install pipx # Install uv using pipx pipx install uv
-
Set up the environment and install
mcts-gen:# Create a virtual environment in your project directory uv venv # Activate the environment source .venv/bin/activate # Install mcts-gen with Shogi support uv pip install mcts-gen[shogi]
To exit the virtual environment, simply run
deactivate. -
Configure
gemini-cliwithfastmcp: Instead of manually editingsettings.json, you can use thefastmcpcommand to automatically configure the tool server.fastmcp install gemini-cli .venv/lib/python3.12/site-packages/mcts_gen/fastmcp_server.py:mcp
This command will automatically detect and configure the
mcts_genserver, creating a.gemini/settings.jsonfile for you.Note on the
:mcpsuffix: The:mcpat the end is required becausefastmcp_server.pycontains multiple objects. This suffix explicitly tellsfastmcpwhich object is the MCP server instance to be run.
Agent Context Configuration with uv
Note on v0.0.2+: The instructions below are for older versions or for cases where you need to add custom, additional context. As of v0.0.2, specifying AGENTS.md is not required for the agent to function correctly.
If you installed the package using uv or pip, the AGENTS.md file is included inside the package. To allow the Gemini agent to use it, you need to specify its full path in your .gemini/settings.json file.
Add the path to the context.fileName list. The exact path may vary depending on your Python version and environment.
Example .gemini/settings.json:
{
"context": {
"fileName": [
".venv/lib/python3.12/site-packages/mcts_gen/AGENTS.md",
"GEMINI.md"
]
},
"mcpServers": {
"mcts_gen_simulator_server": {
"command": "uv",
"args": [
"run",
"fastmcp",
"run",
".venv/lib/python3.12/site-packages/mcts_gen/fastmcp_server.py:mcp"
]
}
}
}
For Maintainers: How to Release a New Version
The package publication process is automated using GitHub Actions.
a) Releasing to TestPyPI (for testing)
To release a version to the TestPyPI repository for verification, create and push a git tag with a -test suffix.
# Example for version 0.1.0
git tag v0.1.0-test1
git push origin v0.1.0-test1
b) Releasing to PyPI (Official)
To perform an official release, create and push a git tag that follows the semantic versioning format (e.g., vX.Y.Z).
# Example for version 0.1.0
git tag v0.1.0
git push origin v0.1.0
Development
Testing
To run all tests:
pytest
License
This project is licensed under the GPL-3.0-or-later license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcts_gen-0.0.3.tar.gz.
File metadata
- Download URL: mcts_gen-0.0.3.tar.gz
- Upload date:
- Size: 32.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a81b5df144d40bde8bbc53f9d7f25788ae5d26187b0a9f4818e31b8d73230dc
|
|
| MD5 |
97f68a30874e469c1be293ad1a983ae7
|
|
| BLAKE2b-256 |
5f2c30ac47d886dc9daa0dcf44c4fead52fb2f6f8a3c6a4da9e2966c2e25c154
|
Provenance
The following attestation bundles were made for mcts_gen-0.0.3.tar.gz:
Publisher:
release.yml on akuroiwa/mcts-gen
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mcts_gen-0.0.3.tar.gz -
Subject digest:
4a81b5df144d40bde8bbc53f9d7f25788ae5d26187b0a9f4818e31b8d73230dc - Sigstore transparency entry: 771197034
- Sigstore integration time:
-
Permalink:
akuroiwa/mcts-gen@ff71035f06b60806751370185c827f71848a3090 -
Branch / Tag:
refs/tags/v0.0.3 - Owner: https://github.com/akuroiwa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ff71035f06b60806751370185c827f71848a3090 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mcts_gen-0.0.3-py3-none-any.whl.
File metadata
- Download URL: mcts_gen-0.0.3-py3-none-any.whl
- Upload date:
- Size: 32.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6686b33906c35c3832a5d9993335895e240955561408f229f8c3748a4f25a19c
|
|
| MD5 |
059d25bc60c01617e69e2a5dcbb22df3
|
|
| BLAKE2b-256 |
9df09c2d9c0c65336137e2d98496e0068e294ebc1ecfa6cf0c5e7b06afa31154
|
Provenance
The following attestation bundles were made for mcts_gen-0.0.3-py3-none-any.whl:
Publisher:
release.yml on akuroiwa/mcts-gen
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mcts_gen-0.0.3-py3-none-any.whl -
Subject digest:
6686b33906c35c3832a5d9993335895e240955561408f229f8c3748a4f25a19c - Sigstore transparency entry: 771197036
- Sigstore integration time:
-
Permalink:
akuroiwa/mcts-gen@ff71035f06b60806751370185c827f71848a3090 -
Branch / Tag:
refs/tags/v0.0.3 - Owner: https://github.com/akuroiwa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ff71035f06b60806751370185c827f71848a3090 -
Trigger Event:
push
-
Statement type: