HeadlessMc

Install, launch and control Minecraft: Java Edition clients and servers, also headless.

OtherJavav0.1.0

CodeFactor GitHub All Releases MIT License Github last-commit

[!WARNING] This is a prototype. We are looking forward to feedback and feature requests.

Screenshot

With this MCP server, Claude Code, Codex, Cursor and other MCP clients can:

  • install vanilla, Fabric, Forge and NeoForge versions, Java, and mods from Modrinth (everything HeadlessMc can do),
  • launch several clients and servers at the same time, optionally headless (no display or GPU, e.g. in CI or Docker), each client in its own profile (game directory with its own mods, config and worlds),
  • control running clients: read the screen, click buttons, type, chat, run commands, connect to servers, etc.
  • read the logs of every instance and send console commands to servers.

Setup

AgentInstall
Claude Code/plugin install headlessmc-mcp --marketplace headlesshq/headlessmc-mcp
OpenAI Codexcodex plugin marketplace add headlesshq/headlessmc-mcp, then /plugins, tab HeadlessMc MCP, Install plugin
GitHub Copilot CLIcopilot plugin marketplace add headlesshq/headlessmc-mcp, then copilot plugin install headlessmc-mcp@headlessmc-mcp
Cursorclone this repository and copy plugin to ~/.cursor/plugins/local/headlessmc-mcp, then Developer: Reload Window
Gemini CLIgemini extensions install https://github.com/headlesshq/headlessmc-mcp

For instructions on HeadlessMc itself (installing it, mod testing in CI with MC-Runtime-Test), install the headlessmc-skill as well.

Tools

ToolDescription
hmcRun any HeadlessMc command line, e.g. version install fabric 1.21.5, mod search sodium, login. Long commands keep running, poll them with hmc_job.
hmc_jobOutput and status of a running hmc command.
launch_clientInstall and launch a client (version, loader or profile, headless, offline, server to join, JVM args) and wait until it shows the main menu.
start_serverCreate and start a Paper/Fabric/Purpur/Forge/NeoForge/vanilla server and wait until it has loaded the world.
list_profiles, create_profile, delete_profileManage profiles: client setups with their own game directory.
list_instancesAll launched clients and servers with their status.
instance_logThe latest lines of an instance's output, optionally filtered by a regex.
server_commandWrite a console command to a server and return what it prints.
stop_instanceQuit a client or stop a server (or kill it).
get_screenThe current screen as JSON: buttons and text fields with ids, texts, positions.
get_stateJSON: in world, dead, screen, and metrics like position, health, dimension, server, ping, TPS, players.
click, set_text, press_keyInteract with the current screen. click returns the screen it leads to.
chatSend a chat message or a /command.
connect, disconnectJoin or leave a server.
wait_forWait for in_world, menu, screen:<Name>, log:<regex> or exit.
game_commandRun any HMC-Specifics command inside the game (help, metrics, render, respawn, commands of other mods).

Resource template: hmc://instances/{id}/log.

Several clients at once

Every running client needs its own game directory, otherwise they overwrite each other's files and share a mods folder. launch_client takes an optional profile: a HeadlessMc profile with its own game directory, created in <HeadlessMc data dir>/client/<profile> if it does not exist. Without a profile, a client uses the default game directory of its version, and if another client of that version is already running there, the MCP server creates a new profile (fabric-1.21.8-2, ...) automatically. Versions, libraries and assets are shared between all profiles. Agents can keep profiles for different setups and add mods to them with mod add mod <slug> <profile>.

Game Control

Game control works on every Minecraft version and modloader that HMC-Specifics supports (1.7.10 to 26.x, Forge, Fabric, NeoForge). The server downloads the matching HMC-Specifics jar and puts it, together with the version independent hmc-mcp-bridge mod, into the mods folder of the client before launching it.

  • The root project (src/) is the MCP server, a Quarkus application. It uses HeadlessMc's CDI beans and picocli commands directly, like headlessmc-web. stdout is the MCP channel, so HeadlessMc's console output and progress bars are captured and returned as tool results instead.
  • hmc-mcp-bridge is a mod that is not tied to a Minecraft version. It uses the HMC-Specifics API and starts a small HTTP server on the loopback interface once HMC-Specifics has initialized. The MCP server passes it a random token and a port file with -Dhmc.mcp.token and -Dhmc.mcp.portFile. Without a token the mod does nothing. Command output comes back separately from the game log, and JSON commands make the screen and state machine-readable.

Agents can also control clients you start yourself, with any launcher (the Minecraft Launcher, Prism, MultiMC, your IDE's run configuration, ...). Put two mods into the mods folder:

  • HMC-Specifics for your Minecraft version and modloader,
  • hmc-mcp-bridge from the releases, one jar for every version and modloader.

When a game with these mods was not launched by the MCP server, the bridge creates a random token, listens on a free port of 127.0.0.1 and registers the game in headlessmc-mcp/instances/<pid>.json in the user's state directory ($XDG_STATE_HOME, else ~/.local/state on Linux, ~/Library/Application Support on macOS, %LOCALAPPDATA%\state on Windows). The file is only readable by you and is deleted when the game exits. list_instances picks up these registrations, so the game appears as an attached instance, and the game tools work as for launched clients. The log comes from logs/latest.log. The MCP server never stops attached games on its own, and they have no console for server_command. Launch the game with -Dhmc.mcp.enabled=false to turn the bridge off.

Asking the user

Some things need the user, not the agent. The MCP server uses elicitation when the MCP client supports it:

  • Minecraft EULA: start_server asks the user to accept the EULA with a checkbox before a server is started for the first time. Without elicitation support, the agent has to ask and pass acceptEula.
  • Microsoft login: the login command asks the client to open Microsoft's device code page (URL mode), so the user signs in in their browser and the agent never sees credentials.
  • Prompts of HeadlessMc commands are shown to the user as a form. Passwords and tokens are never requested, the MCP specification forbids that for form elicitation.
  • Deleting a profile with its files asks for confirmation.

Long installs and launches send progress notifications, and cancelling a tool call in the client cancels the HeadlessMc command.

Installing

Download the latest release from GitHub Releases:

FilePlatform
headlessmc-mcp.jarAny platform with Java 25 or newer: java -jar headlessmc-mcp.jar
headlessmc-mcp-windows-x64.exeWindows x64
headlessmc-mcp-linux-x64, headlessmc-mcp-linux-arm64Linux (e.g. Ubuntu) x64 and arm64
headlessmc-mcp-macos-arm64, headlessmc-mcp-macos-x64macOS on Apple silicon and Intel

Building

Requires JDK 25:

git clone --recurse-submodules https://github.com/headlesshq/headlessmc-mcp.git
cd headlessmc-mcp
./gradlew build
# -> build/headlessmc-mcp-<version>-runner.jar (includes the hmc-mcp-bridge mod)
# -> hmc-mcp-bridge/build/libs/hmc-mcp-bridge-<version>.jar

# native executable for the current platform, needs GraalVM 25 (or add -Dquarkus.native.container-build=true for Linux)
./scripts/build-native.sh
# -> build/headlessmc-mcp-<version>-runner

Configuration

PropertyDefaultDescription
hmc.mcp.specifics.version3.0.1HMC-Specifics release to install into clients.
hmc.mcp.specifics.urlGitHub releasesDownload URL template with {tag}, {mc} and {loader}.
hmc.files.game-for-each-versiontrueSeparate game directory per version, so mods folders do not clash.
hmc.mcp.registry<state dir>/headlessmc-mcp/instancesWhere games from other launchers register, set it for the game as well.

All HeadlessMc properties (hmc.*) work as well, as system properties or in HeadlessMc's config file.

The hmc-mcp-bridge mod reads hmc.mcp.token, hmc.mcp.portFile, hmc.mcp.host (127.0.0.1), hmc.mcp.port (0, any free port), hmc.mcp.registry and hmc.mcp.enabled (true) from system properties. Without hmc.mcp.token it registers the game for attaching.

Privacy and terms

The MCP server runs locally and sends no telemetry. See the Privacy Policy and the Terms of Use. HeadlessMc - MCP is not an official Minecraft product and is not approved by or associated with Mojang or Microsoft.

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
npx -y @headlesshq/headlessmc-mcp

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "io-github-headlesshq-headlessmc-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@headlesshq/headlessmc-mcp"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

@headlesshq/headlessmc-mcpnpm

Compatible MCP Clients

HeadlessMc works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More