https://github.com/deemkeen/minecraft-rcon-mcp
a tiny minecraft mcp server, using the rcon interface
https://github.com/deemkeen/minecraft-rcon-mcp
mcp minecraft rcon spring-ai
Last synced: 7 months ago
JSON representation
a tiny minecraft mcp server, using the rcon interface
- Host: GitHub
- URL: https://github.com/deemkeen/minecraft-rcon-mcp
- Owner: deemkeen
- Created: 2025-04-06T11:30:51.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-06T11:55:57.000Z (7 months ago)
- Last Synced: 2025-04-06T12:30:27.802Z (7 months ago)
- Topics: mcp, minecraft, rcon, spring-ai
- Language: Java
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mcp-servers - **minecraft-rcon-mcp** - a tiny minecraft mcp server, using the rcon interface `java` `mcp` `minecraft` `rcon` `spring-ai` `git clone https://github.com/deemkeen/minecraft-rcon-mcp` (🔌 API)
- awesome-mcp-servers - **minecraft-rcon-mcp** - a tiny minecraft mcp server, using the rcon interface `java` `mcp` `minecraft` `rcon` `spring-ai` `git clone https://github.com/deemkeen/minecraft-rcon-mcp` (API)
README
# Minecraft RCON MCP Server
A Spring Boot application that provides a bridge between Model Context Protocol (MCP) and a Minecraft server's RCON interface, allowing AI models to send commands to a Minecraft server. Built with SpringAI.
## Description
This project enables AI models using Spring AI's MCP functionality to interact with a Minecraft server through the RCON protocol. It provides a simple tool that can send commands to the Minecraft server and receive responses, making it possible for AI models to control and query the Minecraft server.
## Prerequisites
- Java 21 or higher
- Maven 3.6 or higher
- A Minecraft server with RCON enabled
## Building the Project
1. Clone the repository:
```bash
git clone https://github.com/yourusername/minecraft-rcon-mcp.git
cd minecraft-rcon-mcp
```
2. Build the project using Maven:
```bash
./mvnw clean package
```
On Windows:
```bash
mvnw.cmd clean package
```
3. The built JAR file will be located in the `target` directory:
```
target/minecraft-rcon-mcp-1.0.0.jar
```
## Configuration
The application can be configured using environment variables or a `.env` file in the project root directory.
### Required Env Param Configuration
- `RCON_HOST`: The hostname or IP address of the Minecraft server (default: `localhost`)
- `RCON_PORT`: The RCON port of the Minecraft server (default: `25575`)
- `RCON_PASSWORD`: The RCON password for authentication (required, no default)
### Optional Configuration
- `logging.file.name`: The name of the log file (default: `rconmcp.log`)
## Usage
Once the application is built and added to an MCP Client with your Env-Params, it exposes a Model Context Protocol (MCP) server that can be used by Spring AI clients to send commands to the Minecraft server.
The MCP server provides a tool called `sendCommand` that takes a Minecraft command as input and returns the response from the server.
## License
[MIT License](https://opensource.org/licenses/MIT)