PitchHut logo
Minecraft API and MCP
A REST API for Minecraft with integrated MCP server functionality.
Pitch

Minecraft API and MCP provides an easy-to-use REST API for Minecraft along with an MCP server for effortless integration with LLM clients like Claude Desktop. Designed for flexibility, it supports various configurations and runs efficiently on your local setup, allowing seamless interaction with Minecraft's environment.

Description

The Minecraft API and MCP project seamlessly integrates a REST API with Minecraft, enabling users to interact with the game through various clients like Claude Desktop and Goose. This toolset allows for executing MCP (Minecraft Commands Protocol) commands on a local server, enriching the gaming experience for those utilizing Language Learning Models (LLMs).

Key Features

  • REST API Integration: Provides a user-friendly API to interact with Minecraft, facilitating easy command execution and server management.
  • MCP Server Implementation: Runs locally from the mcp directory, allowing for efficient connection with MCP clients.
  • Multiple Transport Modes: Options to operate in standard or Server-Sent Events (SSE) mode, adaptable to different user needs.

Server Setup

The MCP server is initiated using the command:

uv run minecraft_mcp.py

For SSE mode, use:

uv run minecraft_mcp.py --transport sse --port 3001

Ensure that the server targets localhost:7070 by default, which can be adjusted through the .env configuration file within the mcp directory.

Client Configuration

Configuration files, such as mcp/mcp_config.json, offer a sample setup for Claude Desktop. Adjust the paths as necessary for seamless integration and operation with clients like Goose.

Database Setup

For proper functionality, ensure that a PostgreSQL database image is operational. Initiate with:

docker compose up -d postgres

Following this, the Gradle command can be executed to start the server, enhancing the overall performance and reliability.

Additional Notes

As the project evolves, the mod identifiers in the Java code may still display as "modid" and "com.example" until further modifications are completed.

0 comments

No comments yet.

Sign in to be the first to comment.