Dmontgomery40 MCP 3D Printer Server

🚀 MCP 3D Printer Server

The MCP 3D Printer Server is an MCP server designed for interacting with 3D printers. It supports connecting to printers via HTTP or WebSocket protocols and offers functions such as file transfer, temperature control, and print status monitoring.

🚀 Quick Start

The MCP 3D Printer Server enables seamless interaction with 3D printers. It provides a variety of features to facilitate the printing process, including file transfer, temperature control, and real - time status monitoring.

✨ Features

Core Features

• File Transfer: Supports uploading G - code files to the printer.
• Temperature Control: Allows setting and reading the printer's temperature parameters.
• Print Control: Provides functions to start, stop, and cancel printing.
• Status Monitoring: Monitors the printer's status in real - time, including current temperature and print progress.

Example Commands

Uploading a G - code File

// Upload a file using HTTP
await fetch('http://localhost:3000/upload', {
    method: 'POST',
    headers: {
        'Content-Type': 'multipart/form-data'
    },
    body: fs.createReadStream('path/to/file.gcode')
});

// Or use WebSocket
const ws = new WebSocket('ws://localhost:3000/ws');
await ws.send(fs.readFileSync('path/to/file.gcode'));

Controlling Printing

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

// Stop printing
await fetch('http://localhost:3000/print/stop');

Reading Temperature

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

📦 Installation

Installing Dependencies

npm install mcp-3d-printer-server

Initializing Configuration

Create a config.json file:

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

Starting the Server

node index.js --config config.json

📚 Documentation

Environment Requirements

• Node.js Version: Must be 18.0.0 or higher.
• Memory: It is recommended to have at least 4GB of memory to handle large STL files.
• Storage Space: Sufficient disk space is required to store uploaded G - code files and temporary files.

Common Issues

Unable to Connect to the Printer

Check the printer's IP address and port, and ensure that the network connection is normal.

Printing Interrupted

Check the server logs for detailed error information and ensure that the printer has no hardware failures.

Temperature Control Failure

Confirm that the printer supports setting the temperature via API and check the relevant permission settings.

Notes

• Compatibility: Currently, it mainly supports mainstream FDM printers. Other types may require additional configuration.
• Performance Optimization: For large - scale printing tasks, it is recommended to enable GZIP compression to reduce data transfer volume.
• Security: Configure HTTPS to ensure the secure transfer of sensitive data.

Badges

License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.

Functional Modules

1. File Transfer Module

• Supports multiple file formats, including G - code, STL, etc.
• Provides upload, download, and delete functions.

2. Temperature Control Module

• Monitors the printer's temperature in real - time.
• Supports setting the target temperature and adjusting the printing speed.

3. Print Status Monitoring Module

• Displays information such as the current print progress and remaining time.
• Provides a logging function for easy debugging and analysis.

Usage Examples

Using the HTTP API

// Get the printer status
const response = await fetch('http://localhost:3000/status');
const status = await response.json();
console.log(status); // { isPrinting: false, currentTemp: 200, targetTemp: 210 }

Using WebSocket for Real - Time Updates

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

ws.onmessage = (event) => {
    const data = JSON.parse(event.data);
    console.log(`Current Temperature: ${data.temperature}`);
};

await ws.send('connect');

Compatibility Notes

• Firmware Version: Must support controlling the printer via the network interface.
• Operating System: Supports Windows, Linux, and macOS.

Troubleshooting

Unable to Connect to the Printer

1. Check the network settings to ensure that the printer and the server are on the same local network.
2. Confirm that the printer's Web service is started.
3. Check the server logs for detailed error information.

Abnormal Temperature Control

1. Ensure that the printer's firmware version supports the temperature control function.
2. Check the relevant permission settings to ensure that the server has permission to access the printer's temperature adjustment interface.

Performance Optimization Suggestions

• File Compression: For large G - code files, use GZIP compression to reduce transfer time.
• Caching Mechanism: Enable file caching on the server side to avoid repeated file downloads and uploads.
• Parallel Processing: If the printer supports multi - threading operations, try to optimize the code to improve processing efficiency.

Development Guide

Contributing Code

1. Fork the project repository.
2. Create a feature branch.
3. Submit the code and create a Pull Request.

Reporting Issues

• Use GitHub Issues to submit bugs or feature requests.
• Please provide detailed error information and reproduction steps.

Appendix

Supported File Formats

• G - code: The standard control language for printers.
• STL: A file format representing 3D surfaces, commonly used for 3D printing pre - processing.

Interface Documentation

For detailed API documentation, please refer to API DOCS.

Thank you for using the MCP 3D Printer Server! If you have any questions or suggestions, please feel free to contact the maintenance team.