Skip to content

Commit 6457920

Browse files
GhostTypesGhostTypes
authored
Merge pull request #2 from GhostTypes/restructure-readme
Restructure README.md
2 parents 992f445 + cbbb9b1 commit 6457920

1 file changed

Lines changed: 107 additions & 85 deletions

File tree

‎README.md‎

Lines changed: 107 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,107 @@
1-
# Meteor MCP Addon 🔌
2-
3-
**Model Context Protocol & Gemini integration for Meteor Client**
4-
5-
![Minecraft](https://img.shields.io/badge/Minecraft-1.21.10-green?style=flat-square)
6-
![Fabric](https://img.shields.io/badge/Fabric-0.17.3-blue?style=flat-square)
7-
![Meteor](https://img.shields.io/badge/Meteor_Client-1.21.10--32-blueviolet?style=flat-square)
8-
![Java](https://img.shields.io/badge/Java-21-orange?style=flat-square)
9-
![MCP](https://img.shields.io/badge/MCP-0.14.1-red?style=flat-square)
10-
11-
A Meteor Client addon that bridges the Model Context Protocol (MCP) with Minecraft. Connect to MCP servers and call their tools directly from StarScript expressions, chat commands, and optionally via Gemini AI.
12-
13-
## Features
14-
15-
| Feature | Description |
16-
|---------|-------------|
17-
| **MCP Server Management** | Connect multiple MCP servers with persistent configuration and auto-connect on startup |
18-
| **StarScript Integration** | Access tools as `{serverName.toolName(args)}` in HUD elements, chat macros, and anywhere starscript placeholders are used. |
19-
| **Dynamic Chat Commands** | Automatically registered `/serverName:toolName` commands with help and tab completion |
20-
| **Gemini AI (Optional)** | Direct requests withi `/gemini` or MCP-enhanced requests with `/gemini-mcp` |
21-
22-
23-
## 📋 Usage
24-
25-
### Connecting MCP Servers
26-
27-
**Via GUI:**
28-
1. Open Meteor GUI (Right Shift) and navigate to the MCP tab
29-
2. Click "Add Server"
30-
3. Enter server name and command (e.g., `npx -y @modelcontextprotocol/server-time`)
31-
4. Enable "Auto Connect" (optional)
32-
5. Save and Connect
33-
34-
**Common MCP Servers:**
35-
36-
| Server | Command | Use Case |
37-
|--------|---------|----------|
38-
| Time | `npx -y @modelcontextprotocol/server-time` | Time zone conversion, current time |
39-
40-
### StarScript Examples
41-
42-
After connecting servers, tools become available in any StarScript context:
43-
44-
```
45-
{time.get_current_time("America/New_York")}
46-
```
47-
48-
Use these expressions in:
49-
- HUD text elements
50-
- Chat macros
51-
- Anywhere Starscript placeholders are used
52-
53-
### Chat Command Examples
54-
55-
```bash
56-
# Time queries
57-
/time:get_current_time timezone="UTC"
58-
```
59-
60-
## 🤖 Gemini AI Integration (Optional)
61-
62-
### Setup
63-
64-
1. Navigate to MCP tab and click "Configure Gemini API"
65-
2. Enter API key from [ai.google.dev](https://ai.google.dev)
66-
3. Select model (Gemini 2.5 Pro, Flash, or Flash Lite)
67-
4. Test connection and save
68-
69-
### Usage
70-
71-
**Simple prompts:**
72-
```bash
73-
/gemini "Explain what StarScript is"
74-
{gemini("What is the current Minecraft version?")}
75-
```
76-
77-
**MCP-enhanced prompts:**
78-
```bash
79-
/gemini-mcp "Read my config.json and explain each setting"
80-
{gemini_mcp("Get the current time in Tokyo")}
81-
```
82-
83-
The `/gemini-mcp` command allows Gemini to automatically discover and call any connected MCP tool. Tool usage is reported in the response.
84-
85-
1+
<div align="center">
2+
<h1>Meteor MCP Addon</h1>
3+
<p><strong>Model Context Protocol & Gemini integration for Meteor Client</strong></p>
4+
5+
<p>
6+
<img src="https://img.shields.io/badge/Minecraft-1.21.10-green?style=for-the-badge" alt="Minecraft">
7+
<img src="https://img.shields.io/badge/Fabric-0.17.3-blue?style=for-the-badge" alt="Fabric">
8+
<img src="https://img.shields.io/badge/Meteor_Client-1.21.10--32-blueviolet?style=for-the-badge" alt="Meteor Client">
9+
<img src="https://img.shields.io/badge/Java-21-orange?style=for-the-badge" alt="Java">
10+
<img src="https://img.shields.io/badge/MCP-0.14.1-red?style=for-the-badge" alt="MCP">
11+
</p>
12+
13+
<p>A Meteor Client addon that bridges the Model Context Protocol (MCP) with Minecraft. Connect to MCP servers and call their tools directly from StarScript expressions, chat commands, and optionally via Gemini AI.</p>
14+
15+
<h2>Features</h2>
16+
<table>
17+
<tr>
18+
<th>Feature</th>
19+
<th>Description</th>
20+
</tr>
21+
<tr>
22+
<td><strong>MCP Server Management</strong></td>
23+
<td>Connect multiple MCP servers with persistent configuration and auto-connect on startup</td>
24+
</tr>
25+
<tr>
26+
<td><strong>StarScript Integration</strong></td>
27+
<td>Access tools as <code>{serverName.toolName(args)}</code> in HUD elements, chat macros, and anywhere starscript placeholders are used.</td>
28+
</tr>
29+
<tr>
30+
<td><strong>Dynamic Chat Commands</strong></td>
31+
<td>Automatically registered <code>/serverName:toolName</code> commands with help and tab completion</td>
32+
</tr>
33+
<tr>
34+
<td><strong>Gemini AI (Optional)</strong></td>
35+
<td>Direct requests with <code>/gemini</code> or MCP-enhanced requests with <code>/gemini-mcp</code></td>
36+
</tr>
37+
</table>
38+
39+
<h2>Usage</h2>
40+
41+
<h3>Connecting MCP Servers</h3>
42+
43+
<table>
44+
<tr><td><strong>Via GUI:</strong></td></tr>
45+
<tr><td>1. Open Meteor GUI (Right Shift) and navigate to the MCP tab</td></tr>
46+
<tr><td>2. Click "Add Server"</td></tr>
47+
<tr><td>3. Enter server name and command (e.g., <code>npx -y @modelcontextprotocol/server-time</code>)</td></tr>
48+
<tr><td>4. Enable "Auto Connect" (optional)</td></tr>
49+
<tr><td>5. Save and Connect</td></tr>
50+
</table>
51+
52+
<p><strong>Common MCP Servers:</strong></p>
53+
54+
<table>
55+
<tr>
56+
<th>Server</th>
57+
<th>Command</th>
58+
<th>Use Case</th>
59+
</tr>
60+
<tr>
61+
<td>Time</td>
62+
<td><code>npx -y @modelcontextprotocol/server-time</code></td>
63+
<td>Time zone conversion, current time</td>
64+
</tr>
65+
</table>
66+
67+
<h3>StarScript Examples</h3>
68+
69+
<table>
70+
<tr><td>After connecting servers, tools become available in any StarScript context:</td></tr>
71+
<tr><td><code>{time.get_current_time("America/New_York")}</code></td></tr>
72+
<tr><td>Use these expressions in:</td></tr>
73+
<tr><td>- HUD text elements</td></tr>
74+
<tr><td>- Chat macros</td></tr>
75+
<tr><td>- Anywhere Starscript placeholders are used</td></tr>
76+
</table>
77+
78+
<h3>Chat Command Examples</h3>
79+
80+
<table>
81+
<tr><td><code># Time queries</code></td></tr>
82+
<tr><td><code>/time:get_current_time timezone="UTC"</code></td></tr>
83+
</table>
84+
85+
<h2>Gemini AI Integration (Optional)</h2>
86+
87+
<h3>Setup</h3>
88+
89+
<table>
90+
<tr><td>1. Navigate to MCP tab and click "Configure Gemini API"</td></tr>
91+
<tr><td>2. Enter API key from <a href="https://ai.google.dev">ai.google.dev</a></td></tr>
92+
<tr><td>3. Select model (Gemini 2.5 Pro, Flash, or Flash Lite)</td></tr>
93+
<tr><td>4. Test connection and save</td></tr>
94+
</table>
95+
96+
<h3>Usage</h3>
97+
98+
<table>
99+
<tr><td><strong>Simple prompts:</strong></td></tr>
100+
<tr><td><code>/gemini "Explain what StarScript is"</code></td></tr>
101+
<tr><td><code>{gemini("What is the current Minecraft version?")}</code></td></tr>
102+
<tr><td><strong>MCP-enhanced prompts:</strong></td></tr>
103+
<tr><td><code>/gemini-mcp "Read my config.json and explain each setting"</code></td></tr>
104+
<tr><td><code>{gemini_mcp("Get the current time in Tokyo")}</code></td></tr>
105+
<tr><td>The <code>/gemini-mcp</code> command allows Gemini to automatically discover and call any connected MCP tool. Tool usage is reported in the response.</td></tr>
106+
</table>
107+
</div>

0 commit comments

Comments
 (0)