|
1 | | -# mcmodding-mcp |
| 1 | +<div align="center"> |
2 | 2 |
|
3 | | -[](https://www.npmjs.com/package/mcmodding-mcp) |
4 | | -[](https://opensource.org/licenses/MIT) |
5 | | -[](https://github.com/OGMatrix/mcmodding-mcp/actions/workflows/ci.yml) |
| 3 | +<img src="docs/logo.png" alt="MCModding-MCP Logo" width="180" /> |
6 | 4 |
|
7 | | -> MCP server providing AI assistants with comprehensive, up-to-date Minecraft modding documentation for Fabric and NeoForge. |
| 5 | +# MCModding-MCP |
8 | 6 |
|
9 | | -## What is this? |
| 7 | +### 🤖 AI-Powered Minecraft Modding Documentation Server |
10 | 8 |
|
11 | | -**mcmodding-mcp** is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that gives AI assistants like Claude direct access to Minecraft modding documentation. Instead of relying on potentially outdated training data, your AI assistant can search real documentation, find code examples, and explain concepts accurately. |
| 9 | +_Give your AI assistant real-time access to Fabric & NeoForge documentation_ |
12 | 10 |
|
13 | | -### Key Benefits |
| 11 | +<br /> |
14 | 12 |
|
15 | | -- **Always Current** - Documentation is indexed weekly from official sources |
16 | | -- **Accurate Answers** - AI responses backed by real documentation, not hallucinations |
17 | | -- **Code Examples** - Searchable code blocks with proper context |
18 | | -- **Semantic Search** - Understands what you mean, not just keywords |
19 | | -- **Zero Config** - Works immediately after installation |
| 13 | +[](https://www.npmjs.com/package/mcmodding-mcp) |
| 14 | +[](https://www.npmjs.com/package/mcmodding-mcp) |
| 15 | +[](https://opensource.org/licenses/MIT) |
| 16 | +[](https://github.com/OGMatrix/mcmodding-mcp/actions/workflows/ci.yml) |
20 | 17 |
|
21 | | -### 📚 Knowledge Base Stats |
| 18 | +<br /> |
22 | 19 |
|
23 | | -Our databases are comprehensive and constantly updated: |
| 20 | +[](https://github.com/OGMatrix/mcmodding-mcp/stargazers) |
| 21 | +[](https://github.com/OGMatrix/mcmodding-mcp/issues) |
| 22 | +[](https://github.com/OGMatrix/mcmodding-mcp/commits) |
| 23 | +[](https://nodejs.org/) |
24 | 24 |
|
25 | | -**Documentation Database** (`mcmodding-docs.db`): |
| 25 | +<br /> |
26 | 26 |
|
27 | | -- **1,000+** Documentation Pages |
28 | | -- **185,000+** Searchable Chunks |
29 | | -- **8,500+** Logical Sections |
30 | | -- **185,000+** Vector Embeddings for Semantic Search |
| 27 | +[📖 Documentation](#available-tools) • [🚀 Quick Start](#quick-start) • [💡 Features](#features) • [🤝 Contributing](#contributing) |
31 | 28 |
|
32 | | -**Parchment Mappings Database** (`parchment-mappings.db`) ✨ **NEW**: |
| 29 | +--- |
| 30 | + |
| 31 | +</div> |
| 32 | + |
| 33 | +## ✨ What is this? |
| 34 | + |
| 35 | +**MCModding-MCP** is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that supercharges AI assistants like Claude with **real, up-to-date** Minecraft modding knowledge. No more hallucinations or outdated API references! |
| 36 | + |
| 37 | +<table> |
| 38 | +<tr> |
| 39 | +<td width="50%"> |
| 40 | + |
| 41 | +### 🎯 Key Benefits |
| 42 | + |
| 43 | +| Feature | Description | |
| 44 | +| ----------------------- | -------------------------------------- | |
| 45 | +| 📅 **Always Current** | Weekly-indexed from official sources | |
| 46 | +| ✅ **Accurate Answers** | Real documentation, not hallucinations | |
| 47 | +| 💻 **Code Examples** | Searchable code blocks with context | |
| 48 | +| 🧠 **Semantic Search** | Understands meaning, not just keywords | |
| 49 | +| ⚡ **Zero Config** | Works immediately after installation | |
| 50 | + |
| 51 | +</td> |
| 52 | +<td width="50%"> |
| 53 | + |
| 54 | +### 📊 Live Statistics |
33 | 55 |
|
34 | | -- **149,000+** Minecraft Classes |
35 | | -- **831,000+** Methods with Parameter Names |
36 | | -- **166,000+** Fields with Documentation |
37 | | -- **2.3M+** Documented Parameters |
38 | | -- Full Javadoc coverage from Parchment project |
| 56 | +| Database | Content | |
| 57 | +| ----------------- | ----------------------------- | |
| 58 | +| 📚 **Docs** | 1,000+ pages, 185K+ chunks | |
| 59 | +| 🗺️ **Mappings** | 831K+ methods, 166K+ fields | |
| 60 | +| 🧩 **Examples** | 1,000+ battle-tested patterns | |
| 61 | +| 🔍 **Embeddings** | 185K+ semantic vectors | |
| 62 | +| 📖 **Javadocs** | 2.3M+ documented parameters | |
39 | 63 |
|
40 | | -This ensures that even obscure API details and internal Minecraft code can be understood. |
| 64 | +</td> |
| 65 | +</tr> |
| 66 | +</table> |
41 | 67 |
|
42 | 68 | --- |
43 | 69 |
|
@@ -530,6 +556,22 @@ See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes and releases. |
530 | 556 |
|
531 | 557 | --- |
532 | 558 |
|
533 | | -<p align="center"> |
534 | | - <strong>Built with care for the Minecraft modding community</strong> |
535 | | -</p> |
| 559 | +<div align="center"> |
| 560 | + |
| 561 | +<br /> |
| 562 | + |
| 563 | +**🎮 Built with ❤️ for the Minecraft modding community** |
| 564 | + |
| 565 | +<br /> |
| 566 | + |
| 567 | +[](https://www.typescriptlang.org/) |
| 568 | +[](https://www.sqlite.org/) |
| 569 | +[](https://modelcontextprotocol.io/) |
| 570 | + |
| 571 | +<br /> |
| 572 | + |
| 573 | +If you find this project useful, please consider giving it a ⭐! |
| 574 | + |
| 575 | +[⬆️ Back to Top](#mcmodding-mcp) |
| 576 | + |
| 577 | +</div> |
0 commit comments