Mcmodding MCP

🚀 mcmodding - mcp

このプロジェクトは、AIアシスタントに最新のMinecraftモッド開発ドキュメントを提供するMCPサーバーです。FabricやNeoForgeなどのモッド開発に役立つ情報をAIが直接参照できるようになります。

🚀 クイックスタート

📦 インストール

# グローバルにインストール
npm install -g mcmodding-mcp

AIクライアントの設定

MCPクライアントの設定（例：Claude Desktop）に以下を追加します。

{
  "mcpServers": {
    "mcmodding": {
      "command": "mcmodding-mcp"
    }
  }
}

これでAIアシスタントがMinecraftモッド開発ドキュメントにアクセスできるようになります。

✨ 主な機能

ハイブリッド検索エンジン

複数の検索戦略を組み合わせて最適な結果を提供します。

自動更新

データベースは起動時に自動的に更新をチェックします。

• ローカルバージョンとGitHubリリースを比較
• ハッシュ検証付きで新しいバージョンをダウンロード
• 更新前にバックアップを作成
• 非ブロッキング - サーバーはすぐに起動

ドキュメントソース

現在、以下のドキュメントをインデックスしています。

• wiki.fabricmc.net - Fabric Wiki（226ページ以上）
• docs.fabricmc.net - 公式Fabricドキュメント（266ページ以上）

💻 使用例

基本的な使用法

search_fabric_docs

スマートフィルタリングでドキュメントを検索します。

// 例: アイテム登録に関する情報を検索
{
  query: "how to register custom items",
  category: "items",           // オプションのフィルター
  loader: "fabric",            // fabric | neoforge
  minecraft_version: "1.21.4"  // オプションのバージョンフィルター
}

get_example

任意のトピックに関する動作するコード例を取得します。

// 例: ブロック登録コードを取得
{
  topic: "custom block with block entity",
  language: "java",
  loader: "fabric"
}

explain_fabric_concept

モッド開発の概念に関する詳細な説明と関連リソースを取得します。

// 例: Mixinsを理解する
{
  concept: "mixins"
}

get_minecraft_version

現在のMinecraftバージョン情報を取得します。

// 最新バージョンを取得
{ type: "latest" }

// すべてのインデックスされたバージョンを取得
{ type: "all" }

🔧 技術詳細

開発セットアップ

# リポジトリをクローン
git clone https://github.com/OGMatrix/mcmodding-mcp.git
cd mcmodding-mcp

# 依存関係をインストール
npm install

# 開発モードで実行
npm run dev

ビルドコマンド

# 開発
npm run dev              # ホットリロード付きのウォッチモード
npm run typecheck        # TypeScriptの型チェック
npm run lint             # ESLint
npm run test             # テストを実行
npm run format           # Prettierによるフォーマット

# 本番
npm run build            # TypeScriptをビルド
npm run build:prod       # 新しいドキュメントインデックスでビルド
npm run index-docs       # 埋め込みを使用してドキュメントをインデックス

プロジェクト構造

mcmodding-mcp/
├── src/
│   ├── index.ts              # MCPサーバーのエントリーポイント
│   ├── db-versioning.ts      # 自動更新システム
│   ├── indexer/
│   │   ├── crawler.ts        # ドキュメントクローラー
│   │   ├── chunker.ts        # テキストチャンキング
│   │   ├── embeddings.ts     # 意味的埋め込み
│   │   ├── store.ts          # SQLiteデータベース
│   │   └── sitemap.ts        # サイトマップ解析
│   ├── services/
│   │   ├── search-service.ts # 検索ロジック
│   │   └── concept-service.ts # 概念説明
│   └── tools/
│       ├── searchDocs.ts     # search_fabric_docsハンドラー
│       ├── getExample.ts     # get_exampleハンドラー
│       └── explainConcept.ts # explain_fabric_conceptハンドラー
├── scripts/
│   └── index-docs.ts         # ドキュメントインデックス化スクリプト
├── data/
│   ├── mcmodding-docs.db     # SQLiteデータベース
│   └── manifest.json         # バージョンマニフェスト
└── dist/                     # コンパイルされたJavaScript

データベーススキーマ

-- ドキュメント: 完全なドキュメントページ
CREATE TABLE documents (
  id INTEGER PRIMARY KEY,
  url TEXT UNIQUE NOT NULL,
  title TEXT NOT NULL,
  content TEXT NOT NULL,
  category TEXT NOT NULL,
  loader TEXT NOT NULL,          -- fabric | neoforge | shared
  minecraft_version TEXT,
  hash TEXT NOT NULL             -- 変更検出用
);

-- チャンク: 検索可能なコンテンツ単位
CREATE TABLE chunks (
  id TEXT PRIMARY KEY,
  document_id INTEGER NOT NULL,
  chunk_type TEXT NOT NULL,      -- title | section | code | full
  content TEXT NOT NULL,
  section_heading TEXT,
  code_language TEXT,
  word_count INTEGER,
  has_code BOOLEAN
);

-- 埋め込み: 意味的検索ベクトル
CREATE TABLE embeddings (
  chunk_id TEXT PRIMARY KEY,
  embedding BLOB NOT NULL,       -- 384次元のFloat32Array
  dimension INTEGER NOT NULL,
  model TEXT NOT NULL            -- Xenova/all-MiniLM-L6-v2
);

-- 高速テキスト検索用のFTS5インデックス
CREATE VIRTUAL TABLE documents_fts USING fts5(...);
CREATE VIRTUAL TABLE chunks_fts USING fts5(...);

📚 ドキュメント

リリースワークフロー

このプロジェクトは、自動リリースにrelease - pleaseを使用しています。

ブランチ戦略

動作方法

1. コンベンショナルコミットを使用してdevブランチにコミットをプッシュします。
2. Release - pleaseがリリースPR（dev → prod）を管理します。
3. マージされると、自動的にリリースが行われます：npm publish + GitHubリリース + データベースアップロード
4. 変更はdevブランチに同期されます。

詳細はRELEASE_WORKFLOW.mdを参照してください。

設定

環境変数

自動更新の無効化

DB_PATHをカスタム場所に設定することで、更新を手動で管理できます。

DB_PATH=/path/to/my/database.db mcmodding-mcp

統計

典型的なインデックスには以下が含まれます。

🤝 コントリビューション

コントリビューションを歓迎します！ガイドラインはCONTRIBUTING.mdを参照してください。

コントリビューションガイド

1. リポジトリをフォークします。
2. devブランチから機能ブランチを作成します。
3. コンベンショナルコミットで変更を加えます。
4. devブランチにPRを提出します。

📄 ライセンス

MITライセンス - 詳細はLICENSEを参照してください。

🙏 謝辞

• Fabric Documentation - 公式Fabricドキュメント
• Fabric Wiki - コミュニティウィキ
• Model Context Protocol - MCP仕様
• Transformers.js - ローカルML埋め込み
• better - sqlite3 - 高速SQLiteバインディング

愛情を込めてMinecraftモッド開発コミュニティのために構築されました