Skip to content

Commit 69f7937

Browse files
OGMatrixLCookman
andcommitted
fix: use unified tag prefix for database manager and enhance README
- Changed tagPrefix from 'examples-v' to 'v' for mod-examples database - Changed tagPrefix from 'mappings-v' to 'v' for parchment-mappings database - Added data folder to .gitignore - Enhanced README with visually appealing header, logo, and live badges - Removed unnecessary commit step from weekly workflow Fixes #14 Co-authored-by: LCookman <LCookman@users.noreply.github.com>
1 parent 2d3c648 commit 69f7937

2 files changed

Lines changed: 72 additions & 43 deletions

File tree

.github/workflows/update-docs-weekly.yml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -106,19 +106,6 @@ jobs:
106106
# Upload mappings database
107107
gh release upload "$TAG" data/parchment-mappings.db data/parchment-mappings-manifest.json --clobber
108108
109-
- name: Commit and Push to Dev
110-
run: |
111-
git add data/mcmodding-docs.db data/db-manifest.json
112-
git add data/parchment-mappings.db data/parchment-mappings-manifest.json
113-
114-
# Check if there are changes to commit
115-
if git diff --staged --quiet; then
116-
echo "No changes to commit"
117-
else
118-
git commit -m "Weekly documentation and mappings update [skip ci]" --no-verify
119-
git push origin dev
120-
fi
121-
122109
- name: Log summary
123110
if: always()
124111
run: |

README.md

Lines changed: 72 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,69 @@
1-
# mcmodding-mcp
1+
<div align="center">
22

3-
[![npm version](https://img.shields.io/npm/v/mcmodding-mcp.svg)](https://www.npmjs.com/package/mcmodding-mcp)
4-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5-
[![CI](https://github.com/OGMatrix/mcmodding-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/OGMatrix/mcmodding-mcp/actions/workflows/ci.yml)
3+
<img src="docs/logo.png" alt="MCModding-MCP Logo" width="180" />
64

7-
> MCP server providing AI assistants with comprehensive, up-to-date Minecraft modding documentation for Fabric and NeoForge.
5+
# MCModding-MCP
86

9-
## What is this?
7+
### 🤖 AI-Powered Minecraft Modding Documentation Server
108

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_
1210

13-
### Key Benefits
11+
<br />
1412

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+
[![npm version](https://img.shields.io/npm/v/mcmodding-mcp?style=for-the-badge&logo=npm&logoColor=white&color=CB3837)](https://www.npmjs.com/package/mcmodding-mcp)
14+
[![npm downloads](https://img.shields.io/npm/dm/mcmodding-mcp?style=for-the-badge&logo=npm&logoColor=white&color=blue)](https://www.npmjs.com/package/mcmodding-mcp)
15+
[![License: MIT](https://img.shields.io/badge/License-MIT-green?style=for-the-badge&logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/MIT)
16+
[![CI](https://img.shields.io/github/actions/workflow/status/OGMatrix/mcmodding-mcp/ci.yml?style=for-the-badge&logo=github&label=CI)](https://github.com/OGMatrix/mcmodding-mcp/actions/workflows/ci.yml)
2017

21-
### 📚 Knowledge Base Stats
18+
<br />
2219

23-
Our databases are comprehensive and constantly updated:
20+
[![GitHub stars](https://img.shields.io/github/stars/OGMatrix/mcmodding-mcp?style=flat-square&logo=github&label=Stars)](https://github.com/OGMatrix/mcmodding-mcp/stargazers)
21+
[![GitHub issues](https://img.shields.io/github/issues/OGMatrix/mcmodding-mcp?style=flat-square&logo=github&label=Issues)](https://github.com/OGMatrix/mcmodding-mcp/issues)
22+
[![GitHub last commit](https://img.shields.io/github/last-commit/OGMatrix/mcmodding-mcp?style=flat-square&logo=github&label=Last%20Commit)](https://github.com/OGMatrix/mcmodding-mcp/commits)
23+
[![Node.js](https://img.shields.io/badge/Node.js-≥20.0.0-339933?style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org/)
2424

25-
**Documentation Database** (`mcmodding-docs.db`):
25+
<br />
2626

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)
3128

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
3355

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 |
3963

40-
This ensures that even obscure API details and internal Minecraft code can be understood.
64+
</td>
65+
</tr>
66+
</table>
4167

4268
---
4369

@@ -530,6 +556,22 @@ See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes and releases.
530556

531557
---
532558

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+
[![Made with TypeScript](https://img.shields.io/badge/Made%20with-TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
568+
[![Powered by SQLite](https://img.shields.io/badge/Powered%20by-SQLite-003B57?style=for-the-badge&logo=sqlite&logoColor=white)](https://www.sqlite.org/)
569+
[![Uses MCP](https://img.shields.io/badge/Uses-Model%20Context%20Protocol-8B5CF6?style=for-the-badge)](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

Comments
 (0)