You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,13 @@ A Fabric mod that implements a Model Context Protocol (MCP) server, enabling AI
4
4
5
5
## Overview
6
6
7
-
This mod creates an HTTP server within the Minecraft client that accepts MCP protocol requests, allowing Large Language Models to execute Minecraft commands safely and efficiently. The mod includes comprehensive safety validation to prevent destructive operations.
7
+
This mod creates an HTTP server within the Minecraft client or dedicated server that accepts MCP protocol requests, allowing Large Language Models to execute Minecraft commands safely and efficiently. The mod includes comprehensive safety validation to prevent destructive operations.
8
+
9
+
It is designed to be fully compatible with both Single-Player (Integrated Server) and Multiplayer Dedicated Servers.
8
10
9
11
## Features
10
12
13
+
-**Server and Client Support**: Works on both single-player and dedicated server environments.
11
14
-**MCP Protocol Support**: Full implementation of Model Context Protocol for AI interaction
12
15
-**Safety Validation**: Comprehensive command filtering and validation system
13
16
-**Asynchronous Execution**: Non-blocking command execution to maintain game performance
@@ -34,9 +37,17 @@ This mod creates an HTTP server within the Minecraft client that accepts MCP pro
34
37
35
38
The MCP server starts automatically when you launch Minecraft with the mod installed. By default, it runs on `localhost:8080`.
36
39
40
+
### Server vs Client Modes
41
+
42
+
The mod detects if it is running in a Client (Single Player) or a Dedicated Server environment:
43
+
-**Client Mode**: Full feature support, including the `take_screenshot` tool, which uses the local game window.
44
+
-**Dedicated Server Mode**: Has access to tools like `execute_commands`, `get_player_info`, and `get_blocks_in_area`, enabling full AI manipulation of the world without rendering. The `take_screenshot` tool is disabled in server mode since there is no rendering context. Note that `get_player_info` currently selects the first online player on the server to report its location.
45
+
46
+
If playing Single Player, the integrated server logic runs through the client-side MCP.
47
+
37
48
### Configuration
38
49
39
-
The mod creates a configuration file at `config/mcp-client.json`:
50
+
The mod creates a configuration file at `config/mcp.json`:
40
51
41
52
```json
42
53
{
@@ -267,7 +278,7 @@ Capture a screenshot of the current Minecraft game screen. Optionally, you can s
267
278
268
279
For debugging purposes, you can enable local saving of every screenshot captured by the MCP server.
269
280
270
-
1. Open `config/mcp-client.json`.
281
+
1. Open `config/mcp.json`.
271
282
2. Set `"save_screenshots_for_debug": true` in the `client` section.
272
283
3. Screenshots will be saved to the `mcp_debug_screenshots/` directory in your Minecraft instance folder.
273
284
4. Files are named using the pattern: `screenshot_YYYYMMDD_HHMMSS_SSS.png`.
0 commit comments