Dmontgomery40 MCP 3D Printer Server

🚀 MCP 3D プリンターサーバー

MCP 3D プリンターサーバーは、3D プリンターとやり取りするための MCP サーバーです。HTTP または WebSocket プロトコルを介してプリンターに接続し、ファイル転送、温度制御、印刷状態監視などの機能を提供します。

🚀 クイックスタート

MCP 3D プリンターサーバーを使用することで、3D プリンターとのやり取りが容易になります。以下に基本的な使用方法を説明します。

✨ 主な機能

コア機能

• ファイル転送: G-code ファイルをプリンターにアップロードできます。
• 温度制御: プリンターの温度パラメータを設定および読み取ることができます。
• 印刷制御: 印刷の開始、停止、キャンセル機能を提供します。
• 状態監視: プリンターの状態をリアルタイムで監視し、現在の温度、印刷進捗などを確認できます。

機能モジュール

1. ファイル転送モジュール

• G-code、STL などの複数のファイル形式をサポートします。
• アップロード、ダウンロード、削除機能を提供します。

2. 温度制御モジュール

• プリンターの温度をリアルタイムで監視します。
• 目標温度を設定し、印刷速度を調整できます。

3. 印刷状態監視モジュール

• 現在の印刷進捗、残り時間などの情報を表示します。
• デバッグや分析に便利なログ記録機能を提供します。

📦 インストール

依存関係のインストール

npm install mcp-3d-printer-server

設定の初期化

config.json ファイルを作成します。

{
    "printer": {
        "url": "http://your-printer-ip:port",
        "wsUrl": "ws://your-printer-ip:port"
    },
    "server": {
        "port": 3000,
        "host": "localhost"
    }
}

サーバーの起動

node index.js --config config.json

💻 使用例

基本的な使用法

G-code ファイルのアップロード

// 使用 HTTP 方式上传文件
await fetch('http://localhost:3000/upload', {
    method: 'POST',
    headers: {
        'Content-Type': 'multipart/form-data'
    },
    body: fs.createReadStream('path/to/file.gcode')
});

// 或者使用 WebSocket 方式
const ws = new WebSocket('ws://localhost:3000/ws');
await ws.send(fs.readFileSync('path/to/file.gcode'));

印刷の制御

// 启动打印
await fetch('http://localhost:3000/print/start', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        filename: 'example.gcode'
    })
});

// 停止打印
await fetch('http://localhost:3000/print/stop');

温度の読み取り

const response = await fetch('http://localhost:3000/temperature');
const temperatureData = await response.json();
console.log(temperatureData); // { extruderTemp: 200, bedTemp: 60 }

高度な使用法

HTTP API の使用

// 获取打印机状态
const response = await fetch('http://localhost:3000/status');
const status = await response.json();
console.log(status); // { isPrinting: false, currentTemp: 200, targetTemp: 210 }

WebSocket によるリアルタイム更新

const ws = new WebSocket('ws://localhost:3000/ws');

ws.onmessage = (event) => {
    const data = JSON.parse(event.data);
    console.log(`当前温度: ${data.temperature}`);
};

await ws.send('connect');

📚 ドキュメント

環境要件

• Node.js バージョン: 18.0.0 以上が必要です。
• メモリ: 大型の STL ファイルを処理するために、少なくとも 4GB のメモリが推奨されます。
• ストレージ: アップロードされた G-code ファイルと一時ファイルを保存するために十分なディスク容量が必要です。

互換性について

• Firmware バージョン: ネットワークインターフェイスを介したプリンター制御をサポートする必要があります。
• オペレーティングシステム: Windows、Linux、macOS をサポートしています。

よくある質問

プリンターに接続できない場合

プリンターの IP アドレスとポートが正しいことを確認し、ネットワーク接続が正常であることを確認してください。

印刷中に中断する場合

サーバーログを確認して詳細なエラー情報を取得し、プリンターにハードウェア障害がないことを確認してください。

温度制御が失敗する場合

プリンターが API を介した温度設定をサポートしていることを確認し、関連する権限設定を確認してください。

注意事項

• 互換性: 現在は主流の FDM プリンターを主にサポートしており、他のタイプのプリンターでは追加の設定が必要な場合があります。
• パフォーマンス最適化: 大規模な印刷タスクの場合は、GZIP 圧縮を有効にしてデータ転送量を削減することをおすすめします。
• セキュリティ: 機密データの安全な転送を確保するために、HTTPS を設定してください。

開発ガイド

コードの貢献

1. プロジェクトリポジトリを Fork します。
2. 機能ブランチを作成します。
3. コードをコミットし、Pull Request を作成します。

問題の報告

• GitHub Issues を使用してバグを報告したり、機能要求を提出してください。
• 詳細なエラー情報と再現手順を提供してください。

付録

サポートされるファイル形式

• G-code: プリンターの標準制御言語です。
• STL: 3D 表面を表すファイル形式で、3D 印刷の前処理によく使用されます。

インターフェイスドキュメント

詳細な API ドキュメントは API DOCS を参照してください。

バッジ

📄 ライセンス

このプロジェクトは MIT ライセンスに準拠しています。詳細については LICENSE ファイルを参照してください。

MCP 3D プリンターサーバーをご利用いただき、ありがとうございます！何か問題や提案があれば、いつでもメンテナンスチームにご連絡ください。