Dmontgomery40 MCP 3D Printer Server

🚀 MCP 3D 打印機服務器

MCP 3D 打印機服務器是一款用於與 3D 打印機進行交互的 MCP 服務器。它支持通過 HTTP 或 WebSocket 協議連接打印機，具備文件傳輸、溫度控制、打印狀態監控等實用功能，能有效提升 3D 打印的便捷性和效率。

🚀 快速開始

MCP 3D 打印機服務器支持通過 HTTP 或 WebSocket 協議連接到打印機，並提供文件傳輸、溫度控制、打印狀態監控等功能。以下是使用該服務器的基本步驟：

安裝依賴

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 文件上傳到打印機，同時支持多種文件格式，包括 G-code、STL 等，還提供上傳、下載和刪除功能。
• 溫度控制：可以設置和讀取打印機的溫度參數，即時監控打印機溫度，支持設置目標溫度並調整打印速度。
• 打印控制：提供啟動、停止和取消打印的功能。
• 狀態監控：即時監控打印機的狀態，包括當前溫度、打印進度等，顯示當前打印進度、剩餘時間等信息，還提供日誌記錄功能，便於調試和分析。

📦 安裝指南

環境要求

• Node.js 版本：必須是 18.0.0 或更高版本。
• 內存：建議至少 4GB 內存以處理大型 STL 文件。
• 存儲空間：需要足夠的磁盤空間來存放上傳的 G-code 文件和臨時文件。

安裝步驟

1. 安裝依賴：

npm install mcp-3d-printer-server

2. 初始化配置： 創建一個 config.json 文件：

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

3. 啟動服務器：

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');

📚 詳細文檔

常見問題

無法連接打印機

檢查打印機的 IP 地址和端口是否正確，確保網絡連接正常。

打印過程中斷

查看服務器日誌以獲取詳細錯誤信息，並確保打印機沒有硬件故障。

溫度控制失敗

確認打印機支持通過 API 設置溫度，並檢查相關權限設置。

注意事項

⚠️ 重要提示

• 兼容性：目前主要支持主流的 FDM 打印機，其他類型可能需要額外配置。
• 安全性：配置 HTTPS 以確保敏感數據的安全傳輸。

💡 使用建議

• 性能優化：對於大規模打印任務，建議啟用 GZIP 壓縮以減少數據傳輸量。

兼容性說明

• Firmware 版本：必須支持通過網絡接口控制打印機。
• 操作系統：支持 Windows、Linux 和 macOS。

問題排查

打印機無法連接

1. 檢查網絡設置，確保打印機和服務器在同一局域網內。
2. 確認打印機的 Web 服務是否已啟動。
3. 查看服務器日誌以獲取詳細錯誤信息。

溫度控制異常

1. 確保打印機固件版本支持溫度控制功能。
2. 檢查相關權限設置，確保服務器有權限訪問打印機的溫度調節接口。

性能優化建議

• 文件壓縮：對於大型 G-code 文件，可以使用 GZIP 壓縮以減少傳輸時間。
• 緩存機制：在服務器端啟用文件緩存，避免重複下載和上傳文件。
• 並行處理：如果打印機支持多線程操作，可以嘗試優化代碼以提高處理效率。

開發指南

貢獻代碼

1. Fork 項目倉庫。
2. 創建功能分支。
3. 提交代碼並創建 Pull Request。

問題報告

• 使用 GitHub Issues 提交 bug 或提出功能需求。
• 請提供詳細的錯誤信息和復現步驟。

附錄

支持的文件格式

• G-code：打印機的標準控制語言。
• STL：表示三維表面的文件格式，常用於 3D 打印前處理。

接口文檔

詳細的 API 文檔請參閱 API DOCS。

🔧 技術細節

功能模塊

1. 文件傳輸模塊

• 支持多種文件格式，包括 G-code、STL 等。
• 提供上傳、下載和刪除功能。

2. 溫度控制模塊

• 即時監控打印機溫度。
• 支持設置目標溫度並調整打印速度。

3. 打印狀態監控模塊

• 顯示當前打印進度、剩餘時間等信息。
• 提供日誌記錄功能，便於調試和分析。

📄 許可證

此項目遵循 MIT 許可證。請參閱 LICENSE 文件以獲取詳細信息。

徽章

感謝使用 MCP 3D 打印機服務器！如果有任何問題或建議，請隨時聯繫維護團隊。