@nataliapc/mcp-openmsx 1.1.4 → 1.1.8

package/README.md

@@ -12,6 +12,7 @@ This project creates a bridge between modern AI-assisted development (e.g. GitHu
 
 - **Emulator Control**: Launch, configure, manage openMSX instances, and replay timelines.
 - **Media Management**: Handle ROM cartridges, floppy disks, and cassette tapes.
+- **BASIC Programming Support**: Tools to facilitate BASIC language programming and development.
 - **Debugging Tools**: Full CPU debugging with breakpoints, memory inspection, and step execution.
 - **Video Control**: VDP register manipulation and screen capture.
 - **Memory Operations**: Read/write RAM, VRAM, and I/O port access.
@@ -43,11 +44,14 @@ The MCP server translates high-level commands from your Copilot AI into `TCL` co
 
 ### Emulator Control Tools
 - `emu_control`: Controls an openMSX emulator: _`launch`, `close`, `powerOn`, `powerOff`, `reset`, `getEmulatorSpeed`, `setEmulatorSpeed`, `machineList`, `extensionList`, `wait`_.
-- `emu_replay`: Controls emulation timeline: _`start`, `strop`, `status`, `goBack`, `absoluteGoto`, `truncate`, `saveReplay`, `loadReplay`_.
+- `emu_replay`: Controls emulation timeline: _`start`, `stop`, `status`, `goBack`, `absoluteGoto`, `truncate`, `saveReplay`, `loadReplay`_.
 - `emu_info`: Obtain informacion about the current emulated machine: _`getStatus`, `getSlotsMap`, `getIOPortsMap`_.
 - `emu_media`: Manage ROM, disk, and tape media: _`tapeInsert`, `tapeRewind`, `tapeEject`, `romInsert`, `romEject`, `diskInsert`, `diskInsertFolder`, `diskEject`_.
 - `emu_vdp`: Manage VDP (Video Display Processor): _`getPalette`, `getRegisters`, `getRegisterValue`, `setRegisterValue`, `screenGetMode`, `screenGetFullText`_.
 
+### Programming Tools
+- `basic_programming`: BASIC tools: _`newProgram`, `runProgram`, `setProgram`, `getFullProgram`, `getFullProgramAdvanced`, `listProgramLines`, `deleteProgramLines`_.
+
 ### Debugging Tools
 - `debug_run`: Control execution: _`break`, `isBreaked`, `continue`, `stepIn`, `stepOut`, `stepOver`, `stepBack`, `runTo`_.
 - `debug_cpu`: Read/write CPU registers, CPU info, Stack pile, and Disassemble code: _`getCpuRegisters`, `getRegister`, `setRegister`, `getStackPile`, `disassemble`, `getActiveCpu`_.
@@ -59,8 +63,46 @@ The MCP server translates high-level commands from your Copilot AI into `TCL` co
 - `emu_keyboard`: Send text input to emulator: _`sendText`_.
 - `emu_savestates`: Save and restore machine states: _`load`, `save`, `list`_.
 - `screen_shot`: Capture emulator screen: _`as_image`, `to_file`_.
-- `screen_dump`: Export screen data as BASIC BSAVE.
+- `screen_dump`: Export screen data as BASIC BSAVE instruction.
+
+## 📚 Available MCP Resources
+
+### What are MCP Resources?
+
+MCP resources are structured data sets, documentation, and helper files that extend the capabilities of the MCP server. They provide essential information such as machine definitions, extension lists, media templates, and programming examples, enabling more powerful automation, testing, and development workflows for MSX software within the MCP-openMSX environment.
+
+### Available Resources
+
+There are more than 60 resources available, some included directly in the MCP and others accessible via download when queried. They are organized into the following categories:
+
+- `Processors` (Z80, R800)
+- `Bios` (Bios ROM, DOS ROM, SUBROM, ...)
+- `System`
+- `Audio`
+- `Video`
+- `Programming` (ASM, BASIC, ...)
+- `MSX-DOS`
+- `MSX-UNAPI`
+
+And two books:
+
+- `MSX2 Technical Handbook`
+- `The MSX Red Book`
+
+### Resources from:
+
+- [Grauw MSX Assembly Page](https://map.grauw.nl/)
+- [Z80 Heaven Wiki](http://z80-heaven.wikidot.com/)
+- [The MSX Red Book](https://github.com/gseidler/The-MSX-Red-Book)
+- [MSX2 Technical Handbook](https://github.com/Konamiman/MSX2-Technical-Handbook)
+- [Konamiman MSX-UNAPI-specification](https://github.com/Konamiman/MSX-UNAPI-specification)
+- [BiFi MSX Net](http://bifi.msxnet.org/msxnet/)
+- [MSX Wiki](https://www.msx.org/wiki/Main_Page)
+- [MSX Banzai!](http://msxbanzai.tni.nl/)
+
+Thanks to the authors of these resources, who have made them available under various licenses. This MCP server includes some of these resources to enhance the development experience.
 
+The rights to these resources belong to their respective authors and are distributed under the licenses they have defined.
 
 ## 🚀 Quick Start
 
@@ -131,6 +173,7 @@ Add to your `claude_desktop_config.json`:
 | `OPENMSX_SHARE_DIR` | Directory containing openMSX data files (machines, extensions, etc.) | System dependent | `/home/myuser/.openmsx/share` |
 | `OPENMSX_SCREENSHOT_DIR` | Directory where screenshots will be saved | Default for openmsx | `/myproject/screenshots` |
 | `OPENMSX_SCREENDUMP_DIR` | Directory where screen dumps will be saved | Default for openmsx | `/myproject/screendumps` |
+| `OPENMSX_REPLAYS_DIR` | Directory where replay files will be saved | Default for openmsx | `/myproject/replays` |
 | `MCP_TRANSPORT` | Transport mode (`stdio` or `http`) | `stdio` | `http` |
 | `MCP_HTTP_PORT` | Port number for HTTP transport mode | `3000` | `8080` |
 
@@ -154,6 +197,7 @@ export OPENMSX_EXECUTABLE="openmsx"
 export OPENMSX_SHARE_DIR="/usr/share/openmsx"
 export OPENMSX_SCREENSHOT_DIR="/my_project/screenshots"
 export OPENMSX_SCREENDUMP_DIR="/my_project/screendumps"
+export OPENMSX_REPLAYS_DIR="/my_project/replays"
 export MCP_HTTP_PORT=3000
 ```
 

package/dist/openmsx.js

@@ -12,6 +12,7 @@ import path from 'path';
  * OpenMSX class for controlling the openMSX emulator via TCL commands over TCP socket
  */
 export class OpenMSX {
+    lastMachine = null;
     process = null;
     isConnected = false;
     /**
@@ -34,13 +35,14 @@ export class OpenMSX {
             try {
                 // Check if emulator is already running
                 if (this.process && !this.process.killed) {
-                    safeResolve("Error: openMSX emulator is already running. Close it first before launching a new instance.");
+                    safeResolve(`Error: openMSX emulator instance is already running (currrent machine: ${this.lastMachine}). Close it first before launching a new one.`);
                     return;
                 }
                 // Build command line arguments
                 const args = ['-control', 'stdio'];
                 // Add machine parameter if specified
                 if (machine) {
+                    this.lastMachine = machine; // Store last machine for future reference
                     args.push('-machine', machine);
                 }
                 // Add extensions if specified
@@ -86,6 +88,8 @@ export class OpenMSX {
                             if (!resolved) {
                                 try {
                                     this.writeData('<openmsx-control>\n');
+                                    // Set save settings on exit off
+                                    this.sendCommand('set save_settings_on_exit off');
                                     // Set renderer to SDL
                                     this.sendCommand('set renderer SDLGL-PP');
                                     // set machine on
@@ -148,6 +152,7 @@ export class OpenMSX {
                 return;
             }
             this.process.on('exit', () => {
+                this.lastMachine = null; // Clear last machine on exit
                 this.isConnected = false;
                 this.process = null;
                 resolve("Ok: Emulator process closed successfully");
@@ -187,10 +192,15 @@ export class OpenMSX {
                 return response;
             }
             // Parse machine_info output into key-value pairs
+            const skipInfo = ['issubslotted', 'input_port', 'slot', 'isexternalslot', 'output_port'];
             const parameters = response.trim().split(' ');
             const machineInfo = {};
             for (const param of parameters) {
                 const trimmedLine = param.trim();
+                // Skip certain parameters that are not useful
+                if (skipInfo.includes(trimmedLine)) {
+                    continue;
+                }
                 if (trimmedLine) {
                     const value = await this.sendCommand(`machine_info ${trimmedLine}`);
                     machineInfo[trimmedLine] = value.trim();