mcp-3d-printer-server 1.2.2 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,6 +2,9 @@ import { PrinterImplementation } from "../types.js";
2
2
  export declare class PrusaImplementation extends PrinterImplementation {
3
3
  private buildAuthHeaders;
4
4
  private buildBaseUrl;
5
+ private defaultProtocolFor;
6
+ private isDefaultPort;
7
+ private isPrusaConnectCloudHost;
5
8
  private isFallbackStatus;
6
9
  private getWithFallback;
7
10
  private postWithFallback;
@@ -5,12 +5,43 @@ import FormData from "form-data";
5
5
  export class PrusaImplementation extends PrinterImplementation {
6
6
  buildAuthHeaders(apiKey) {
7
7
  return {
8
+ Accept: "application/json",
8
9
  "X-Api-Key": apiKey,
9
10
  Authorization: `Bearer ${apiKey}`,
10
11
  };
11
12
  }
12
13
  buildBaseUrl(host, port) {
13
- return `http://${host}:${port}`;
14
+ const trimmedHost = host.trim();
15
+ const trimmedPort = port.trim();
16
+ if (!trimmedHost) {
17
+ throw new Error("Prusa host is required.");
18
+ }
19
+ const rawBaseUrl = /^[a-z][a-z\d+.-]*:\/\//i.test(trimmedHost)
20
+ ? trimmedHost
21
+ : `${this.defaultProtocolFor(trimmedHost, trimmedPort)}://${trimmedHost}`;
22
+ const parsed = new URL(rawBaseUrl);
23
+ if (trimmedPort && !parsed.port && !this.isDefaultPort(parsed.protocol, trimmedPort)) {
24
+ parsed.port = trimmedPort;
25
+ }
26
+ return parsed.toString().replace(/\/$/, "");
27
+ }
28
+ defaultProtocolFor(host, port) {
29
+ if (port === "443" || this.isPrusaConnectCloudHost(host)) {
30
+ return "https";
31
+ }
32
+ return "http";
33
+ }
34
+ isDefaultPort(protocol, port) {
35
+ return (protocol === "https:" && port === "443") || (protocol === "http:" && port === "80");
36
+ }
37
+ isPrusaConnectCloudHost(host) {
38
+ try {
39
+ const parsed = new URL(/^[a-z][a-z\d+.-]*:\/\//i.test(host) ? host : `https://${host}`);
40
+ return parsed.hostname.toLowerCase() === "connect.prusa3d.com";
41
+ }
42
+ catch {
43
+ return host.toLowerCase().split(":")[0] === "connect.prusa3d.com";
44
+ }
14
45
  }
15
46
  isFallbackStatus(error) {
16
47
  if (!isAxiosError(error)) {
@@ -61,6 +92,7 @@ export class PrusaImplementation extends PrinterImplementation {
61
92
  }
62
93
  async getStatus(host, port, apiKey) {
63
94
  const response = await this.getWithFallback(host, port, apiKey, [
95
+ "/api/v1/status",
64
96
  "/api/v1/printer",
65
97
  "/api/printer",
66
98
  ]);
@@ -1,20 +1,2 @@
1
1
  #!/usr/bin/env node
2
- declare class ThreeDPrinterMCPServerSSE {
3
- private server;
4
- private printerFactory;
5
- private stlManipulator;
6
- private app;
7
- private sessions;
8
- constructor();
9
- private setupExpressApp;
10
- private startSessionCleanup;
11
- setupErrorHandling(): void;
12
- setupHandlers(): void;
13
- setupResourceHandlers(): void;
14
- setupToolHandlers(): void;
15
- getPrinterStatus(host: string, port?: string, type?: string, apiKey?: string, bambuSerial?: string, bambuToken?: string): Promise<any>;
16
- getPrinterFiles(host: string, port?: string, type?: string, apiKey?: string, bambuSerial?: string, bambuToken?: string): Promise<any>;
17
- getPrinterFile(host: string, filename: string, port?: string, type?: string, apiKey?: string, bambuSerial?: string, bambuToken?: string): Promise<any>;
18
- run(): Promise<void>;
19
- }
20
- export default ThreeDPrinterMCPServerSSE;
2
+ export {};
@@ -1,318 +1,8 @@
1
1
  #!/usr/bin/env node
2
- import { Server } from "@modelcontextprotocol/sdk/server/index.js";
3
- import { SSEServerTransport } from "@modelcontextprotocol/sdk/server/sse.js";
4
- import express from 'express';
5
- import cors from 'cors';
6
- import { v4 as uuidv4 } from 'uuid';
7
- import { ListResourcesRequestSchema, ReadResourceRequestSchema, ErrorCode, McpError } from "@modelcontextprotocol/sdk/types.js";
8
- import axios from "axios";
9
- import dotenv from "dotenv";
10
- import fs from "fs";
11
- import path from "path";
12
- import { PrinterFactory } from "./printers/printer-factory.js";
13
- import { STLManipulator } from "./stl/stl-manipulator.js";
14
- // Load environment variables from .env file
15
- dotenv.config();
16
- // Default values
17
- const DEFAULT_HOST = process.env.PRINTER_HOST || "localhost";
18
- const DEFAULT_PORT = process.env.PRINTER_PORT || "80";
19
- const DEFAULT_API_KEY = process.env.API_KEY || "";
20
- const DEFAULT_TYPE = process.env.PRINTER_TYPE || "octoprint";
21
- const TEMP_DIR = process.env.TEMP_DIR || path.join(process.cwd(), "temp");
22
- // SSE Server configuration
23
- const SSE_PORT = parseInt(process.env.SSE_PORT || "3000");
24
- // Slicer configuration
25
- const DEFAULT_SLICER_TYPE = process.env.SLICER_TYPE || "prusaslicer";
26
- const DEFAULT_SLICER_PATH = process.env.SLICER_PATH || "";
27
- const DEFAULT_SLICER_PROFILE = process.env.SLICER_PROFILE || "";
28
- // Bambu-specific default values
29
- const DEFAULT_BAMBU_SERIAL = process.env.BAMBU_SERIAL || "";
30
- const DEFAULT_BAMBU_TOKEN = process.env.BAMBU_TOKEN || "";
31
- // Ensure temp directory exists
32
- if (!fs.existsSync(TEMP_DIR)) {
33
- fs.mkdirSync(TEMP_DIR, { recursive: true });
2
+ var _a;
3
+ (_a = process.env).MCP_TRANSPORT ?? (_a.MCP_TRANSPORT = "streamable-http");
4
+ if (!process.env.MCP_HTTP_PORT && process.env.SSE_PORT) {
5
+ process.env.MCP_HTTP_PORT = process.env.SSE_PORT;
34
6
  }
35
- class ThreeDPrinterMCPServerSSE {
36
- constructor() {
37
- this.sessions = new Map();
38
- this.server = new Server({
39
- name: "mcp-3d-printer-server",
40
- version: "1.0.0"
41
- }, {
42
- capabilities: {
43
- resources: {},
44
- tools: {}
45
- }
46
- });
47
- this.printerFactory = new PrinterFactory();
48
- this.stlManipulator = new STLManipulator(TEMP_DIR);
49
- this.app = express();
50
- this.setupExpressApp();
51
- this.setupHandlers();
52
- this.setupErrorHandling();
53
- this.startSessionCleanup();
54
- }
55
- setupExpressApp() {
56
- // Enable CORS for all origins
57
- this.app.use(cors({
58
- origin: '*',
59
- methods: ['GET', 'POST', 'OPTIONS'],
60
- allowedHeaders: ['Content-Type', 'Accept', 'Last-Event-ID'],
61
- credentials: true
62
- }));
63
- // Parse JSON bodies
64
- this.app.use(express.json({ limit: '50mb' }));
65
- // SSE endpoint - establishes the event stream
66
- this.app.get('/sse', async (req, res) => {
67
- const sessionId = uuidv4();
68
- const messagesPath = `/messages?session_id=${sessionId}`;
69
- // Set SSE headers
70
- res.setHeader('Content-Type', 'text/event-stream');
71
- res.setHeader('Cache-Control', 'no-cache');
72
- res.setHeader('Connection', 'keep-alive');
73
- res.setHeader('X-Accel-Buffering', 'no');
74
- // Send initial endpoint event
75
- res.write(`event: endpoint\ndata: ${messagesPath}\n\n`);
76
- // Create transport for this session
77
- const transport = new SSEServerTransport(messagesPath);
78
- this.sessions.set(sessionId, { transport, lastActivity: Date.now() });
79
- // Send periodic ping events to keep connection alive
80
- const pingInterval = setInterval(() => {
81
- if (!res.writableEnded) {
82
- res.write(`event: ping\ndata: ${new Date().toISOString()}\n\n`);
83
- }
84
- }, 30000);
85
- // Handle client disconnect
86
- req.on('close', () => {
87
- clearInterval(pingInterval);
88
- this.sessions.delete(sessionId);
89
- res.end();
90
- });
91
- // Handle transport errors
92
- transport.onerror = (error) => {
93
- console.error(`SSE Transport error for session ${sessionId}:`, error);
94
- clearInterval(pingInterval);
95
- this.sessions.delete(sessionId);
96
- res.end();
97
- };
98
- });
99
- // Messages endpoint - handles JSON-RPC messages
100
- this.app.post('/messages', async (req, res) => {
101
- const sessionId = req.query.session_id;
102
- if (!sessionId || !this.sessions.has(sessionId)) {
103
- res.status(400).json({
104
- jsonrpc: "2.0",
105
- error: {
106
- code: -32600,
107
- message: "Invalid or missing session ID"
108
- }
109
- });
110
- return;
111
- }
112
- const session = this.sessions.get(sessionId);
113
- session.lastActivity = Date.now();
114
- try {
115
- // Handle the message through the transport
116
- const result = await session.transport.handleMessage(req.body);
117
- if (result) {
118
- res.json(result);
119
- }
120
- else {
121
- res.status(202).send(); // Accepted, no response needed
122
- }
123
- }
124
- catch (error) {
125
- console.error('Error handling message:', error);
126
- res.status(500).json({
127
- jsonrpc: "2.0",
128
- error: {
129
- code: -32603,
130
- message: "Internal error",
131
- data: error instanceof Error ? error.message : String(error)
132
- }
133
- });
134
- }
135
- });
136
- // Health check endpoint
137
- this.app.get('/health', (req, res) => {
138
- res.json({
139
- status: 'ok',
140
- server: 'mcp-3d-printer-server',
141
- transport: 'sse',
142
- sessions: this.sessions.size
143
- });
144
- });
145
- // Root endpoint
146
- this.app.get('/', (req, res) => {
147
- res.json({
148
- name: 'MCP 3D Printer Server (SSE)',
149
- version: '1.0.0',
150
- endpoints: {
151
- sse: '/sse',
152
- messages: '/messages',
153
- health: '/health'
154
- },
155
- transport: 'sse',
156
- documentation: 'https://github.com/DMontgomery40/mcp-3D-printer-server'
157
- });
158
- });
159
- }
160
- startSessionCleanup() {
161
- // Clean up inactive sessions every 5 minutes
162
- setInterval(() => {
163
- const now = Date.now();
164
- const timeout = 10 * 60 * 1000; // 10 minutes
165
- for (const [sessionId, session] of this.sessions.entries()) {
166
- if (now - session.lastActivity > timeout) {
167
- console.log(`Cleaning up inactive session: ${sessionId}`);
168
- this.sessions.delete(sessionId);
169
- }
170
- }
171
- }, 5 * 60 * 1000);
172
- }
173
- setupErrorHandling() {
174
- this.server.onerror = (error) => {
175
- console.error("[MCP Error]", error);
176
- };
177
- process.on("SIGINT", async () => {
178
- console.log("\nShutting down SSE server...");
179
- // Disconnect all printers
180
- await this.printerFactory.disconnectAll();
181
- // Close all sessions
182
- for (const [sessionId, _] of this.sessions.entries()) {
183
- this.sessions.delete(sessionId);
184
- }
185
- await this.server.close();
186
- process.exit(0);
187
- });
188
- }
189
- setupHandlers() {
190
- this.setupResourceHandlers();
191
- this.setupToolHandlers();
192
- }
193
- setupResourceHandlers() {
194
- // List available resources
195
- this.server.setRequestHandler(ListResourcesRequestSchema, async () => {
196
- return {
197
- resources: [
198
- {
199
- uri: `printer://${DEFAULT_HOST}/status`,
200
- name: "3D Printer Status",
201
- mimeType: "application/json",
202
- description: "Current status of the 3D printer including temperatures, print progress, and more"
203
- },
204
- {
205
- uri: `printer://${DEFAULT_HOST}/files`,
206
- name: "3D Printer Files",
207
- mimeType: "application/json",
208
- description: "List of files available on the 3D printer"
209
- }
210
- ],
211
- templates: [
212
- {
213
- uriTemplate: "printer://{host}/status",
214
- name: "3D Printer Status",
215
- mimeType: "application/json"
216
- },
217
- {
218
- uriTemplate: "printer://{host}/files",
219
- name: "3D Printer Files",
220
- mimeType: "application/json"
221
- },
222
- {
223
- uriTemplate: "printer://{host}/file/{filename}",
224
- name: "3D Printer File Content",
225
- mimeType: "application/gcode"
226
- }
227
- ]
228
- };
229
- });
230
- // Read resource
231
- this.server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
232
- const uri = request.params.uri;
233
- const match = uri.match(/^printer:\/\/([^\/]+)\/(.+)$/);
234
- if (!match) {
235
- throw new McpError(ErrorCode.InvalidRequest, `Invalid resource URI: ${uri}`);
236
- }
237
- const [, host, resource] = match;
238
- let content;
239
- try {
240
- if (resource === "status") {
241
- content = await this.getPrinterStatus(host);
242
- }
243
- else if (resource === "files") {
244
- content = await this.getPrinterFiles(host);
245
- }
246
- else if (resource.startsWith("file/")) {
247
- const filename = resource.substring(5);
248
- content = await this.getPrinterFile(host, filename);
249
- }
250
- else {
251
- throw new McpError(ErrorCode.InvalidRequest, `Unknown resource: ${resource}`);
252
- }
253
- return {
254
- contents: [
255
- {
256
- uri,
257
- mimeType: resource.startsWith("file/") ? "application/gcode" : "application/json",
258
- text: typeof content === "string" ? content : JSON.stringify(content, null, 2)
259
- }
260
- ]
261
- };
262
- }
263
- catch (error) {
264
- if (axios.isAxiosError(error)) {
265
- throw new McpError(ErrorCode.InternalError, `API error: ${error.response?.data?.error || error.message}`);
266
- }
267
- throw error;
268
- }
269
- });
270
- }
271
- setupToolHandlers() {
272
- // Tool handlers remain the same as in the stdio version
273
- // ... (copy all tool handlers from the original index.ts)
274
- }
275
- // Delegating methods to printer implementations (same as original)
276
- async getPrinterStatus(host, port = DEFAULT_PORT, type = DEFAULT_TYPE, apiKey = DEFAULT_API_KEY, bambuSerial = DEFAULT_BAMBU_SERIAL, bambuToken = DEFAULT_BAMBU_TOKEN) {
277
- const implementation = this.printerFactory.getImplementation(type);
278
- if (type.toLowerCase() === "bambu") {
279
- const bambuApiKey = `${bambuSerial}:${bambuToken}`;
280
- return implementation.getStatus(host, port, bambuApiKey);
281
- }
282
- return implementation.getStatus(host, port, apiKey);
283
- }
284
- async getPrinterFiles(host, port = DEFAULT_PORT, type = DEFAULT_TYPE, apiKey = DEFAULT_API_KEY, bambuSerial = DEFAULT_BAMBU_SERIAL, bambuToken = DEFAULT_BAMBU_TOKEN) {
285
- const implementation = this.printerFactory.getImplementation(type);
286
- if (type.toLowerCase() === "bambu") {
287
- const bambuApiKey = `${bambuSerial}:${bambuToken}`;
288
- return implementation.getFiles(host, port, bambuApiKey);
289
- }
290
- return implementation.getFiles(host, port, apiKey);
291
- }
292
- async getPrinterFile(host, filename, port = DEFAULT_PORT, type = DEFAULT_TYPE, apiKey = DEFAULT_API_KEY, bambuSerial = DEFAULT_BAMBU_SERIAL, bambuToken = DEFAULT_BAMBU_TOKEN) {
293
- const implementation = this.printerFactory.getImplementation(type);
294
- if (type.toLowerCase() === "bambu") {
295
- return implementation.getFile(host, port, apiKey, bambuSerial, bambuToken, filename);
296
- }
297
- return implementation.getFile(host, port, apiKey, filename);
298
- }
299
- // ... (copy all other delegating methods from original index.ts)
300
- async run() {
301
- // Connect SSE transports to the server
302
- for (const [sessionId, session] of this.sessions.entries()) {
303
- await this.server.connect(session.transport);
304
- }
305
- // Start Express server
306
- this.app.listen(SSE_PORT, () => {
307
- console.log(`🚀 MCP 3D Printer Server (SSE) running on http://localhost:${SSE_PORT}`);
308
- console.log(`📡 SSE endpoint: http://localhost:${SSE_PORT}/sse`);
309
- console.log(`💬 Messages endpoint: http://localhost:${SSE_PORT}/messages`);
310
- });
311
- }
312
- }
313
- // Check if running as main module
314
- if (import.meta.url === `file://${process.argv[1]}`) {
315
- const server = new ThreeDPrinterMCPServerSSE();
316
- server.run().catch(console.error);
317
- }
318
- export default ThreeDPrinterMCPServerSSE;
7
+ void import("./index.js");
8
+ export {};
@@ -7,6 +7,7 @@ export type OperationResult = {
7
7
  error?: string;
8
8
  operationId: string;
9
9
  };
10
+ export type SlicerType = 'prusaslicer' | 'cura' | 'slic3r' | 'orcaslicer' | 'orcaslicer-bambulab' | 'bambustudio';
10
11
  export type TransformationType = 'scale' | 'rotate' | 'translate' | 'extendBase' | 'customModify';
11
12
  export type TransformationAxis = 'x' | 'y' | 'z' | 'all';
12
13
  export type BoundingBox = {
@@ -30,6 +31,14 @@ export declare class STLManipulator extends EventEmitter {
30
31
  * Generate a unique operation ID
31
32
  */
32
33
  private generateOperationId;
34
+ private validateSlicerExecutable;
35
+ private splitProfileList;
36
+ private parseOrcaProfileArgs;
37
+ private warnForMissingProfiles;
38
+ private appendOrcaProfileArgs;
39
+ private resolveOrcaGcodeOutput;
40
+ private resolveBambuMachinePresetPath;
41
+ private resolveSlicerTimeoutMs;
33
42
  /**
34
43
  * Load STL file and return geometry and bounding box
35
44
  */
@@ -92,13 +101,13 @@ export declare class STLManipulator extends EventEmitter {
92
101
  /**
93
102
  * Slice an STL or 3MF file using the specified slicer
94
103
  * @param stlFilePath Path to the input STL or 3MF file
95
- * @param slicerType Type of slicer (prusaslicer, cura, slic3r, orcaslicer, bambustudio)
104
+ * @param slicerType Type of slicer (prusaslicer, cura, slic3r, orcaslicer, orcaslicer-bambulab, bambustudio)
96
105
  * @param slicerPath Path to the slicer executable
97
106
  * @param slicerProfile Optional path to the slicer profile/config file
98
107
  * @param progressCallback Optional callback for progress updates
99
108
  * @returns Path to the generated G-code or sliced 3MF file
100
109
  */
101
- sliceSTL(stlFilePath: string, slicerType: 'prusaslicer' | 'cura' | 'slic3r' | 'orcaslicer' | 'bambustudio', slicerPath: string, slicerProfile?: string, progressCallback?: ProgressCallback, printerPreset?: string): Promise<string>;
110
+ sliceSTL(stlFilePath: string, slicerType: SlicerType, slicerPath: string, slicerProfile?: string, progressCallback?: ProgressCallback, printerPreset?: string, filamentProfile?: string): Promise<string>;
102
111
  /**
103
112
  * Enhanced version of confirmTemperatures with better error handling
104
113
  * @param gcodePath Path to the G-code file