mcp-3d-printer-server 0.1.0 → 0.2.2

package/.env.example

@@ -0,0 +1,17 @@
+# Printer configuration
+PRINTER_HOST=localhost
+PRINTER_PORT=80
+PRINTER_TYPE=octoprint
+API_KEY=your_api_key_here
+
+# Bambu-specific configuration
+BAMBU_SERIAL=your_bambu_serial_here
+BAMBU_TOKEN=your_bambu_token_here
+
+# Temp directory for file processing
+TEMP_DIR=./temp
+
+# Slicer configuration
+SLICER_TYPE=prusaslicer
+SLICER_PATH=/path/to/slicer/executable
+SLICER_PROFILE=/path/to/slicer/profile

package/README.md

@@ -1,5 +1,14 @@
 # MCP 3D Printer Server
 
+[![npm version](https://img.shields.io/npm/v/mcp-3d-printer-server.svg)](https://www.npmjs.com/package/mcp-3d-printer-server)
+[![License: GPL-2.0](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
+[![TypeScript](https://img.shields.io/badge/TypeScript-4.9%2B-blue)](https://www.typescriptlang.org/)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/yourusername/mcp-3d-printer-server/graphs/commit-activity)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D%2018.0.0-green.svg)](https://nodejs.org/en/download/)
+[![Downloads](https://img.shields.io/npm/dm/mcp-3d-printer-server.svg)](https://www.npmjs.com/package/mcp-3d-printer-server)
+[![GitHub stars](https://img.shields.io/github/stars/yourusername/mcp-3d-printer-server.svg?style=social&label=Star)](https://github.com/yourusername/mcp-3d-printer-server)
+
 ## Description
 
 This is a server that allows MCP users to connect with the API endpoints of these 3D Printers: 
@@ -14,6 +23,8 @@ This is a server that allows MCP users to connect with the API endpoints of thes
 
 This server is a Model Context Protocol (MCP) server for connecting Claude with 3D printer management systems. It allows Claude to interact with 3D printers through the APIs of various printer management systems such as OctoPrint, Klipper (via Moonraker), Duet, Repetier, and Bambu Labs printers.
 
+**Note on Resource Usage**: This MCP server includes advanced 3D model manipulation features that can be memory-intensive when working with large STL files. Please see the "Limitations and Considerations" section for important information about memory usage and performance.
+
 ## Features
 
 - Get printer status (temperatures, print progress, etc.)
@@ -21,6 +32,19 @@ This server is a Model Context Protocol (MCP) server for connecting Claude with
 - Upload G-code files to the printer
 - Start, cancel, and monitor print jobs
 - Set printer temperatures
+- Advanced STL file manipulation:
+  - Extend base for better adhesion
+  - Scale models uniformly or along specific axes
+  - Rotate models around any axis
+  - Translate (move) models
+  - Modify specific sections of STL files (top, bottom, center, or custom)
+- Comprehensive STL analysis with detailed model information
+- Generate multi-angle SVG visualizations of STL files
+- Real-time progress reporting for long operations
+- Error handling with detailed diagnostics
+- Slice STL files to generate G-code
+- Confirm temperature settings in G-code files
+- Complete end-to-end workflow from STL modification to printing
 
 ## Installation
 
@@ -63,6 +87,11 @@ TEMP_DIR=/path/to/temp/dir
 # Bambu Labs specific configuration
 BAMBU_SERIAL=your_printer_serial
 BAMBU_TOKEN=your_access_token
+
+# Slicer configuration
+SLICER_TYPE=prusaslicer  # Options: prusaslicer, cura, slic3r
+SLICER_PATH=/path/to/slicer/executable
+SLICER_PROFILE=/path/to/slicer/profile
 ```
 
 ## Usage with Claude Desktop
@@ -191,7 +220,169 @@ Creality Cloud is Creality's management system for their printers.
 
 ## Available Tools
 
-### get_printer_status
+### STL Manipulation Tools
+
+> **Memory Usage Warning**: The following STL manipulation tools load entire 3D models into memory. For large or complex STL files (>10MB), these operations can consume significant memory. When using these tools within the MCP environment, be mindful of memory constraints.
+
+#### get_stl_info
+
+Get detailed information about an STL file, including dimensions, vertex count, and bounding box.
+
+```json
+{
+  "stl_path": "/path/to/file.stl"
+}
+```
+
+#### extend_stl_base
+
+Extend the base of an STL file by a specified amount.
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "extension_inches": 2
+}
+```
+
+#### scale_stl
+
+Scale an STL model uniformly or along specific axes.
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "scale_factor": 1.5
+}
+```
+
+Or for non-uniform scaling:
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "scale_x": 1.2,
+  "scale_y": 1.0,
+  "scale_z": 1.5
+}
+```
+
+#### rotate_stl
+
+Rotate an STL model around specific axes (in degrees).
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "rotate_x": 45,
+  "rotate_y": 0,
+  "rotate_z": 90
+}
+```
+
+#### translate_stl
+
+Move an STL model along specific axes (in millimeters).
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "translate_x": 10,
+  "translate_y": 5,
+  "translate_z": 0
+}
+```
+
+#### modify_stl_section
+
+Apply a specific transformation to a selected section of an STL file. This allows for detailed modifications of specific parts of a model.
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "section": "top",
+  "transformation_type": "scale",
+  "value_x": 1.5,
+  "value_y": 1.5, 
+  "value_z": 1.5
+}
+```
+
+For custom section bounds:
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "section": "custom",
+  "transformation_type": "rotate",
+  "value_x": 0,
+  "value_y": 0, 
+  "value_z": 45,
+  "custom_min_x": -10,
+  "custom_min_y": 0,
+  "custom_min_z": -10,
+  "custom_max_x": 10,
+  "custom_max_y": 20,
+  "custom_max_z": 10
+}
+```
+
+#### generate_stl_visualization
+
+Generate an SVG visualization of an STL file from multiple angles (front, side, top, and isometric views).
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "width": 400,
+  "height": 400
+}
+```
+
+#### slice_stl
+
+Slice an STL file to generate G-code.
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "slicer_type": "prusaslicer",
+  "slicer_path": "/path/to/prusaslicer",
+  "slicer_profile": "/path/to/profile.ini"
+}
+```
+
+#### confirm_temperatures
+
+Confirm temperature settings in a G-code file.
+
+```json
+{
+  "gcode_path": "/path/to/file.gcode",
+  "extruder_temp": 200,
+  "bed_temp": 60
+}
+```
+
+#### process_and_print_stl
+
+Process an STL file (extend base), slice it, confirm temperatures, and start printing.
+
+```json
+{
+  "stl_path": "/path/to/file.stl",
+  "extension_inches": 2,
+  "extruder_temp": 200,
+  "bed_temp": 60,
+  "host": "192.168.1.100",
+  "type": "octoprint",
+  "api_key": "YOUR_API_KEY"
+}
+```
+
+### Printer Control Tools
+
+#### get_printer_status
 
 Get the current status of the 3D printer.
 
@@ -290,6 +481,7 @@ Set the temperature of a printer component.
 
 Here are some example commands you can give to Claude after connecting the MCP server:
 
+### Printer Control
 - "What's the current status of my 3D printer?"
 - "Show me the list of files on my printer."
 - "Upload this G-code to my printer: [G-code content]"
@@ -298,6 +490,22 @@ Here are some example commands you can give to Claude after connecting the MCP s
 - "Set the extruder temperature to 200°C."
 - "Set the bed temperature to 60°C."
 
+### STL Manipulation and Printing
+- "Take this STL file and extend the base by 2 inches, then send to slicer and queue up in my printer."
+- "Extend the base of model.stl by 1.5 inches."
+- "Scale this STL file by 150% uniformly."
+- "Scale model.stl to be twice as wide but keep the same height."
+- "Rotate this model 90 degrees around the Z axis."
+- "Move this STL model up by 5mm to create a gap underneath."
+- "Can you modify just the top part of this model to make it 20% larger?"
+- "Analyze this STL file and tell me its dimensions and details."
+- "Generate a visualization of this STL file so I can see what it looks like."
+- "Create SVG visualizations of my model from different angles."
+- "Make the base of this model wider without changing its height."
+- "Slice the modified STL file using PrusaSlicer."
+- "Confirm that the temperatures in the G-code are 200°C for the extruder and 60°C for the bed."
+- "Process this STL file, make the base 2 inches longer, slice it, and start printing, but confirm the temperatures first."
+
 ## Bambu Lab Printer Limitations
 
 Due to the nature of the Bambu Lab printer API, there are some limitations:
@@ -308,6 +516,45 @@ Due to the nature of the Bambu Lab printer API, there are some limitations:
 
 3. **File management**: Files must be uploaded to the "gcodes" directory on the printer.
 
+## Limitations and Considerations
+
+### Memory Usage
+- **Large STL Files**: Processing large or complex STL files can consume significant memory. The entire STL geometry is loaded into memory during operations.
+- **Multiple Operations**: Running multiple STL operations in sequence (especially on large files) may cause memory to accumulate if garbage collection doesn't keep up.
+- **MCP Environment**: Since this runs as an MCP server, be aware that Claude's MCP environment has memory constraints. Complex operations on very large STL files may cause out-of-memory issues.
+
+### STL Manipulation Limitations
+- **Section Modification**: The section-specific modification feature works best on simpler geometries. Complex or non-manifold meshes may produce unexpected results.
+- **Base Extension**: The base extension algorithm works by adding a new geometry underneath the model. For models with complex undersides, results may not be perfect.
+- **Error Handling**: While we've added robust error handling, some edge cases in complex STL files might still cause issues.
+
+### Visualization Limitations
+- **SVG Representation**: The SVG visualization is a simplified schematic representation, not a true 3D render.
+- **Complex Models**: For very complex models, the visualization may not accurately represent all details.
+
+### Performance Considerations
+- **Slicing Operations**: External slicer processes can be CPU-intensive and may take considerable time for complex models.
+- **Progress Reporting**: For large files, progress updates may appear to stall at certain processing stages.
+
+### Testing Recommendations
+- Start with smaller STL files (< 10MB) to test functionality
+- Monitor memory usage when processing large files
+- Test modifications on simple geometries before attempting complex ones
+- Consider running on a system with at least 4GB of available RAM for larger operations
+
+## Badges
+
+| Badge | Description |
+|-------|-------------|
+| [![npm version](https://img.shields.io/npm/v/mcp-3d-printer-server.svg)](https://www.npmjs.com/package/mcp-3d-printer-server) | The current version of the package on npm |
+| [![License: GPL-2.0](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) | This project is licensed under GPL-2.0 |
+| [![TypeScript](https://img.shields.io/badge/TypeScript-4.9%2B-blue)](https://www.typescriptlang.org/) | This project is written in TypeScript 4.9+ |
+| [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/yourusername/mcp-3d-printer-server/graphs/commit-activity) | This project is actively maintained |
+| [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com) | We welcome contributions via Pull Requests |
+| [![Node.js Version](https://img.shields.io/badge/node-%3E%3D%2018.0.0-green.svg)](https://nodejs.org/en/download/) | Requires Node.js 18.0.0 or higher |
+| [![Downloads](https://img.shields.io/npm/dm/mcp-3d-printer-server.svg)](https://www.npmjs.com/package/mcp-3d-printer-server) | Number of downloads per month from npm |
+| [![GitHub stars](https://img.shields.io/github/stars/yourusername/mcp-3d-printer-server.svg?style=social&label=Star)](https://github.com/yourusername/mcp-3d-printer-server) | Number of GitHub stars this project has received |
+
 ## License
 
 GPL-2.0

package/package.json

@@ -1,13 +1,15 @@
 {
     "name": "mcp-3d-printer-server",
-    "version": "0.1.0",
+    "version": "0.2.2",
     "description": "MCP server for connecting Claude with 3D printer management systems",
     "main": "src/index.js",
+    "repository": "https://github.com/DMontgomery40/mcp-3d-printer-server",
     "type": "module",
     "scripts": {
-        "start": "node src/index.js",
-        "dev": "nodemon src/index.js",
-        "test": "echo \"Error: no test specified\" && exit 1"
+        "start": "node dist/index.js",
+        "dev": "nodemon src/index.ts --exec \"npm run build && npm start\"",
+        "build": "tsc",
+        "test": "npm run build && node dist/test/stl-manipulator-test.js"
     },
     "bin": {
         "mcp-3d-printer-server": "./src/index.js"
@@ -31,10 +33,12 @@
         "axios": "^1.6.2",
         "bambu-js": "^2.2.2",
         "dotenv": "^16.3.1",
-        "form-data": "^4.0.0"
+        "form-data": "^4.0.0",
+        "three": "^0.173.0"
     },
     "devDependencies": {
         "@types/node": "^18.0.0",
+        "@types/three": "^0.173.0",
         "nodemon": "^2.0.22"
     }
 }