MCP Klipper Docs

モデルコンテキストプロトコル（MCP）に基づくサーバーで、Claude DesktopにKlipper 3Dプリンターファームウェアのローカライズされたドキュメント検索と設定照会機能を提供し、公式ドキュメントライブラリをリアルタイムで同期し、全文検索インデックスを作成します。

開発者ツール知識管理と記憶 #ドキュメント検索 #3D印刷 #設定照会 #ローカル統合 .TypeScript

スコア : 2.5ポイント

ダウンロード数 : 7.7K

更新時間 : 2026-03-12

サイトを開く

MCP Klipperドキュメントサーバーとは？

これは、Klipper 3Dプリンターファームウェア用に特別に設計されたスマートなドキュメントサーバーです。Klipperの公式ドキュメントを自動的に同期し、全文検索インデックスを作成し、MCPプロトコルを通じてAIアシスタント（Claude Desktopなど）がすべてのドキュメント内容を直接照会し、閲覧できるようにします。従来、Klipperのドキュメントは50以上のファイルに分散しており、ユーザーは設定オプションやトラブルシューティングガイドを手動で検索する必要がありました。このサーバーはすべてのドキュメントを1つのスマートな検索システムに統合し、AIをあなたのKlipper専門アシスタントにします。

MCP Klipperドキュメントサーバーの使い方は？

使用方法は非常に簡単です： 1. Node.jsとnpmをインストールする 2. サーバーパッケージをグローバルにインストールする：npm install -g mcp-klipper-docs 3. Claude DesktopのMCP設定を構成する 4. Claudeを再起動して、Klipperドキュメントの照会を開始するインストール後、ClaudeにKlipperに関する任意の質問を直接することができ、Claudeは自動的にドキュメントから最も関連性の高い情報を検索します。

適用シーン

このツールは、以下のシーンに特に適しています： - 新しいKlipperプリンターを設定する際にパラメータをすばやく検索する - トラブルシューティング時に解決策を検索する - Klipperの機能とベストプラクティスを学ぶ - プリンターのパフォーマンスを最適化する際に公式ドキュメントを参照する - Klipperの設定やマクロを開発する際にAPIを参照する Klipperの初心者でも経験豊富なユーザーでも、このツールから恩恵を受けることができます。

主要機能

🔍 スマートな全文検索

Lunr.js検索エンジンを使用し、キーワード検索、関連性の並べ替え、結果のフィルタリングをサポートします。すべてのKlipperドキュメントを検索し、必要な情報をすばやく見つけることができます。

⚙️ 設定オプションの検索

Config_Referenceドキュメントに特化して最適化されており、特定の設定オプションの詳細な説明、パラメータ、サンプルコードを直接照会することができます。

📚 構造化されたドキュメントの閲覧

ドキュメントは論理的なカテゴリに分類されて組織化されており、ハードウェア設定、キャリブレーション、トラブルシューティングなど11のカテゴリがあり、テーマ別に閲覧しやすくなっています。

🔄 自動ドキュメント同期

Klipperの公式GitHubリポジトリから最新のドキュメントを自動的に同期し、情報が常に最新バージョンであることを保証します。定期更新と手動トリガーをサポートしています。

🤖 MCPプロトコルの統合

Model Context Protocolと完全に互換性があり、Claude Desktop、CursorなどのMCPをサポートするAIツールとシームレスに統合できます。

📊 ドキュメントの統計情報

ドキュメントの数、インデックスの統計、更新状態などの情報を提供し、ドキュメントライブラリの完全性と新鮮さを把握するのに役立ちます。

利点

🎯 ワンストップのドキュメントアクセス：複数のファイル間を移動する必要がなく、すべてのKlipperドキュメントが集中管理されます

⚡ 超高速な検索応答：検索は通常10ミリ秒以内で完了し、手動での検索よりも数百倍速いです

🤖 AI強化体験：ClaudeなどのAIアシスタントにKlipperの専門知識を持たせ、より正確な回答を提供します

📱 ネットワーク接続不要：ドキュメントはローカルに保存されているため、オフラインでも照会できます

🔄 自動更新：常に公式ドキュメントと同期され、手動でのダウンロードと更新が不要です

🔧 開発者に優しい：完全なAPIと設定オプションを提供し、カスタム拡張をサポートします

制限

📶 Claude Desktopが必要：現在は主にClaude Desktopと統合されており、他のAIツールでは追加の設定が必要な場合があります

💾 ローカルストレージを占有：ドキュメントとインデックスを保存するために約50MBのスペースが必要です

🔄 更新遅延：自動更新には1時間の間隔があり、リアルタイムの更新ドキュメントを取得できない場合があります

🔍 検索精度：キーワードマッチングに依存しているため、複雑な問題には複数回のクエリが必要な場合があります

🛠️ 技術的な依存関係：Node.js環境が必要で、非技術的なユーザーにはインストールの敷居がある場合があります

使い方

Node.js環境をインストールする

システムにNode.js 20.0以上がインストールされていることを確認してください。Node.jsの公式ウェブサイトからインストールパッケージをダウンロードできます。

MCP Klipperドキュメントサーバーをインストールする

npmを使用してサーバーパッケージをグローバルにインストールします。これにより、システムに実行可能ファイルがインストールされます。

Claude Desktopを設定する

Claude Desktopの設定ファイルを編集し、MCPサーバーの設定を追加します。設定ファイルの場所は以下の通りです： - Windows: %APPDATA%\Claude\claude_desktop_config.json - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Claude Desktopを再起動する

Claude Desktopアプリケーションを閉じて再起動し、設定を有効にします。

使用を開始する

Claude Desktopで、これからKlipperに関する質問を直接することができ、Claudeは自動的にドキュメントから答えを検索します。

使用例

ケース1：新しいプリンターの設定

新しい3Dプリンターを設定し、Klipperのさまざまなパラメータを設定する必要がある場合、このツールを使用して正しい設定オプションをすばやく検索することができます。

ケース2：トラブルシューティング

プリンターに層ずれ、押出不足、またはその他の問題が発生した場合、トラブルシューティングガイドをすばやく検索することができます。

ケース3：パフォーマンスの最適化

印刷品質を向上させるために、圧力前進、共振補償などの高度な機能を調整する場合。

ケース4：特定の機能の学習

Klipperの特定の機能、例えばマクロプログラミング、ネットワークAPI、または高度なGコードコマンドを学びたい場合。

よくある質問

このツールは無料ですか？

使用するためにネットワーク接続が必要ですか？

どのようなAIアシスタントをサポートしていますか？

ドキュメントの更新頻度はどの程度ですか？

必要な情報が検索できない場合はどうすればいいですか？

自分のドキュメントをカスタムで追加することはできますか？

インストールに失敗した場合はどうすればいいですか？

このツールは私のデータを収集しますか？

🚀 MCP Klipperドキュメントサーバー

AIによるKlipperドキュメントを手軽に利用できるようにする、Model Context Protocol (MCP) サーバーです。Klipper 3Dプリンターファームウェアのドキュメントとのやり取り方法を革新します。

🚀 クイックスタート • 📖 ドキュメント • 🔧 設定 • 🤝 コントリビュート

🖼️ 実際の動作を見る

Claude Desktop内でKlipperのドキュメントにシームレスにアクセスできます。設定を検索し、ドキュメントを閲覧し、3D印刷に関する質問に即座に答えを得ることができます。

🎯 このプロジェクトの重要性

Klipperのドキュメントは充実していますが、数十のMarkdownファイルに分散しています。適切な設定オプションやトラブルシューティングガイドを見つけるには、何度もクリックして検索する必要があります。このプロジェクトはその状況を一変させます。

問題点

🔍 分散したドキュメント：50以上の個別のMarkdownファイル
🐛 設定の複雑さ：特定のオプションの詳細を見つけるのが難しい
⏱️ コンテキストの切り替え：ドキュメントと設定ファイルの間を行き来する必要がある
🤖 AIの制限：ClaudeはローカルのKlipperドキュメントにアクセスできない

解決策

🔎 統合検索：すべてのドキュメントを瞬時に検索できる
⚙️ スマートな設定検索：正確な設定セクションを取得できる
📚 インテリジェントな閲覧：論理的なカテゴリーでナビゲートできる
🤖 AI統合：ClaudeがKlipperの専門家になります

🚀 クイックスタート

前提条件

Node.js >= 20.0.0
npm または yarn
Claude Desktop (MCP統合のため)

インストール

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

# または、プロジェクト内にローカルインストール
npm install mcp-klipper-docs

Claude Desktopの設定

Claude Desktopの設定ファイルを開く：
- Windows：%APPDATA%\Claude\claude_desktop_config.json
- macOS：~/Library/Application Support/Claude/claude_desktop_config.json
MCPサーバーを追加する：

オプション1: グローバルインストール (推奨)

{
  "mcpServers": {
    "klipper-docs": {
      "command": "node",
      "args": ["C:\\Users\\bpuhnk\\AppData\\Roaming\\npm\\node_modules\\mcp-klipper-docs\\dist\\server.js"]
    }
  }
}

オプション2: npxを使用する

{
  "mcpServers": {
    "klipper-docs": {
      "command": "npx",
      "args": ["-y", "mcp-klipper-docs@1.0.1"]
    }
  }
}

オプション3: ローカル開発

{
  "mcpServers": {
    "klipper-docs": {
      "command": "node",
      "args": ["C:\\Users\\bpuhnk\\source\\repos\\MCP_Klipper\\dist\\server.js"]
    }
  }
}

Claude Desktopを再起動する

以上で完了です！ 🎉 ClaudeがすべてのKlipperドキュメントに即座にアクセスできるようになりました。

📦 パッケージ情報

npmパッケージ：mcp-klipper-docs
バージョン：1.0.1
リポジトリ：GitHub
ライセンス：MIT
作者：Ben Phillips

🔍 検証

インストール後、すべてが正常に動作することを確認します：

# パッケージのインストールを確認
npm list -g mcp-klipper-docs

# サーバーの起動をテスト
node C:\Users\bpuhnk\AppData\Roaming\npm\node_modules\mcp-klipper-docs\dist\server.js

# またはnpxを使用
npx -y mcp-klipper-docs@1.0.1

🛠️ できること

🔍 ドキュメントを検索する

"BLTouchの設定を検索する"
"圧力前進に関する情報を探す"
"押出機のチューニングガイドを探す"

⚙️ 設定の詳細を取得する

"[押出機]の設定を取得する"
"stepper_xの設定を表示する"
"bed_meshのパラメーターは何ですか？"

📚 セクション別に閲覧する

"キャリブレーションのドキュメントを閲覧する"
"ハードウェア設定のセクションを表示する"
"トラブルシューティングセクションに何がありますか？"

📊 統計情報を取得する

"利用可能なドキュメントはいくつありますか？"
"ドキュメントにはどのようなセクションがありますか？"
"インデックスの統計情報を表示する"

🏗️ アーキテクチャ

コアコンポーネント

graph TD
    A[Claude Desktop] --> B[MCP Protocol]
    B --> C[MCP Server]
    C --> D[Search Engine]
    C --> E[Document Parser]
    C --> F[Git Sync]
    D --> G[Lunr.js Index]
    E --> H[Markdown Files]
    F --> I[Klipper Repository]

技術スタック

コンポーネント	技術	目的
ランタイム	Node.js 20+	JavaScriptの実行
言語	TypeScript 5.3+	型安全と開発
プロトコル	MCP SDK 1.0+	Claude Desktopとの統合
検索	Lunr.js 2.3+	全文検索インデックス
Git	simple-git 3.22+	リポジトリの同期
パーシング	marked 11.1+	Markdownの処理
メタデータ	gray-matter 4.0+	フロントマターの抽出

データフロー

リポジトリの同期：最新のKlipperドキュメントを自動的に取得する
ドキュメントのパーシング：コンテンツ、メタデータ、構造を抽出する
インデックスの構築：検索可能なlunr.jsインデックスを作成する
MCP統合：MCPプロトコルを介してツールとリソースを公開する
AIとのやり取り：Claudeがドキュメントを検索して取得する

📋 利用可能なツール

🔎 `search_klipper_docs`

すべてのKlipperドキュメントを関連性のスコア付けで検索します。

パラメーター：

query (文字列): 検索用語
limit (数値, オプション): 最大結果数 (デフォルト: 10)
section (文字列, オプション): セクションでフィルタリング

例：

{
  "query": "BLTouchの設定",
  "limit": 5,
  "section": "ハードウェア"
}

⚙️ `get_config_option`

Config_Referenceから特定の設定セクションを取得します。

パラメーター：

option (文字列): 設定オプション名
include_examples (ブール値, オプション): コード例を含める

例：

{
  "option": "押出機",
  "include_examples": true
}

📚 `browse_documentation`

セクション別にドキュメントを閲覧するか、概要情報を取得します。

パラメーター：

section (文字列, オプション): 閲覧するセクション
include_stats (ブール値, オプション): 統計情報を含める

例：

{
  "section": "キャリブレーション",
  "include_stats": true
}

📊 `get_index_stats`

ドキュメントのインデックス統計情報とメタデータを取得します。

パラメーターは不要です。

📁 MCPリソース

すべてのドキュメントファイルはMCPリソースとして利用可能です：

URIスキーム：klipper://docs/{document-id}
形式：メタデータ付きのMarkdown
アクセス：直接のファイル読み取りまたは閲覧

例のリソース：

klipper://docs/Config_Reference
klipper://docs/BLTouch
klipper://docs/Installation
klipper://docs/Troubleshooting

🔧 高度な設定

環境変数

変数	デフォルト	説明
`GIT_REPOSITORY`	`https://github.com/Klipper3d/klipper.git`	KlipperリポジトリのURL
`GIT_BRANCH`	`master`	リポジトリのブランチ
`DATA_DIR`	`./data`	ローカルデータディレクトリ
`LOG_LEVEL`	`info`	ログレベル (debug, info, warn, error)
`UPDATE_INTERVAL`	`3600`	自動更新間隔 (秒)

Dockerデプロイメント

# イメージをビルド
docker build -t mcp-klipper-docs .

# コンテナを実行
docker run -d \
  --name mcp-klipper-docs \
  -v $(pwd)/data:/app/data \
  mcp-klipper-docs

Docker Compose

version: '3.8'
services:
  mcp-klipper-docs:
    build: .
    container_name: mcp-klipper-docs
    volumes:
      - ./data:/app/data
    environment:
      - LOG_LEVEL=info
      - UPDATE_INTERVAL=3600
    restart: unless-stopped

📊 パフォーマンスメトリクス

インデックス統計情報

ドキュメント：56個のKlipperドキュメントファイル
単語：135,000以上のインデックス化された単語
セクション：11個のカテゴライズされたセクション
ビルド時間：完全なインデックスの場合は約400ms
検索速度：一般的なクエリでは10ms未満

メモリ使用量

基本メモリ：約50MB
インデックスメモリ：約25MB
ピークメモリ：更新中は約100MB

ネットワーク使用量

初期クローン：約50MB (一度限り)
更新：約1 - 5MB (変更部分のみ)
API呼び出し：ローカルのみ (外部依存なし)

🧪 開発

ローカル開発のセットアップ

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

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

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

# テストを実行
npm test

# 本番用にビルド
npm run build

プロジェクト構造

mcp-klipper-docs/
├── src/
│   ├── server.ts          # メインのMCPサーバー
│   ├── config.ts          # 設定管理
│   ├── logger.ts          # ロギングユーティリティ
│   ├── git-sync.ts        # Gitリポジトリの操作
│   ├── parser.ts          # Markdownドキュメントのパーシング
│   ├── search.ts          # 検索エンジンの実装
│   ├── types.ts           # TypeScriptの型定義
│   └── errors.ts          # エラーハンドリング
├── tests/                 # テストスイート
├── docs/                  # 追加のドキュメント
├── img/                   # 画像とアセット
├── data/                  # ローカルのKlipperリポジトリ
└── dist/                  # ビルドされたJavaScriptファイル

テスト

# すべてのテストを実行
npm test

# ウォッチモードでテストを実行
npm run test:watch

# カバレッジを含めて実行
npm run test -- --coverage

# コードをリント
npm run lint

# リントの問題を修正
npm run lint:fix