@nataliapc/mcp-openmsx 1.1.4 → 1.1.8

package/dist/utils.js

@@ -78,3 +78,46 @@ export function encodeHtmlEntities(text) {
         return char;
     });
 }
+/**
+ * Encode a string for BASIC program input, escaping special characters
+ * @param text - String to encode
+ * @returns string - Encoded string with special characters escaped
+ */
+export function encodeTypeText(text) {
+    const replacementMap = {
+        '\r': '\\r',
+        '\t': '\\t',
+        '"': '\\"',
+    };
+    return text.replace(/[\r\t"]/g, (char) => {
+        if (replacementMap[char]) {
+            return replacementMap[char];
+        }
+        return char;
+    });
+}
+/**
+ * Check if a response is an error response
+ * @param response - The response string to check
+ * @returns boolean - True if the response indicates an error, false otherwise
+ */
+export function isErrorResponse(response) {
+    return response.startsWith('Error:') || response.startsWith('error:');
+}
+/**
+ * Get the content of a response, formatting it as a CallToolResult
+ * @param response - Array of strings representing the response lines
+ * @param isError - Optional boolean indicating if the response is an error
+ * @returns CallToolResult - Formatted response content
+ */
+export function getResponseContent(response, isError = false) {
+    // Check if any response line starts with "Error:" to automatically set isError to true
+    const hasError = isError || response.some(line => isErrorResponse(line));
+    return {
+        content: response.map(line => ({
+            type: "text",
+            text: line == '' ? "Ok" : line,
+        })),
+        isError: hasError
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nataliapc/mcp-openmsx",
-  "version": "1.1.4",
+  "version": "1.1.8",
   "description": "Model context protocol server for openMSX automation and control",
   "main": "dist/server.js",
   "type": "module",
@@ -45,12 +45,15 @@
     "zod": "^3.24.4"
   },
   "devDependencies": {
+    "@modelcontextprotocol/inspector": "^0.15.0",
+    "@types/mime-types": "^3.0.1",
     "@types/node": "^22.15.27",
     "shx": "^0.4.0",
     "typescript": "^5.8.3"
   },
   "files": [
     "dist/**/*",
+    "resources/**/*",
     "README.md",
     "LICENSE"
   ],

package/resources/audio/toc.json

@@ -0,0 +1,31 @@
+{
+    "title": "MSX Technical Audio info for MSX",
+    "description": "MSX Technical Audio info for MSX",
+    "toc": [
+        {
+            "title": "PSG Registers",
+            "uri": "https://www.msx.org/wiki/PSG_Registers",
+            "description": "Complete reference for MSX PSG (Programmable Sound Generator) registers covering all 16 registers including frequency control, white noise control, voice and I/O port control, amplitude and volume control, envelope form and period control, and I/O parallel port registers. Includes BIOS routines WRTPSG, RDPSG, and GICINI for PSG access and initialization."
+        },
+        {
+            "title": "Konami SCC Sound Chip",
+            "uri": "http://bifi.msxnet.org/msxnet/tech/scc",
+            "description": "Technical documentation for Konami's SCC (Sound Creative Chip) used in MSX cartridges. The SCC provides 5-channel wavetable synthesis with custom waveforms, offering enhanced audio capabilities beyond the standard PSG. Commonly found in Konami game cartridges like Gradius series, providing richer sound effects and music."
+        },
+        {
+            "title": "Konami SCC+ Sound Chip",
+            "uri": "http://bifi.msxnet.org/msxnet/tech/soundcartridge",
+            "description": "Technical documentation for Konami's enhanced SCC+ (Sound Creative Chip Plus) found in later MSX sound cartridges. Improved version of the original SCC providing enhanced wavetable synthesis capabilities, additional sound channels, and better audio quality. Used in advanced Konami cartridges and dedicated sound cartridges for expanded audio functionality."
+        },
+        {
+            "title": "MSX-MIDI",
+            "uri": "https://map.grauw.nl/resources/midi/msx-midi.php",
+            "description": "Complete technical documentation for MSX-MIDI interface covering hardware configuration, MIDI data communication using 8251 IC, baud rate generator with 8253/8254 timer IC, I/O port assignments (0E8H, 0E9H), internal vs external cartridge implementations, and BASIC extensions. Available only for MSX turbo R and later systems with 16K ROM containing MIDI functionality."
+        },
+        {
+            "title": "MGSDRV MML 1.1",
+            "uri": "https://mus.msx.click/index.php?title=MGSDRV_MML_11",
+            "description": "Complete documentation for MGSC MML compiler version 1.11 by Ain (1992-93) that converts MML (Music Macro Language) text files to MGS formatted play data for MGSDRV. Covers control functions, OPLL modes (FM 9 sound/FM 6+rhythm), machine vendor codes (SONY, Panasonic, SANYO), macro definitions, tone definitions, tempo control, and compilation options including real-time playback and debugging features."
+        }
+    ]
+}

package/resources/bios/Calling_BIOS_from_MSX-DOS.md

@@ -0,0 +1,75 @@
+# Calling the BIOS from MSX-DOS  
+
+In the MSX-DOS environment there is no special entry for calling the MSX BIOS, however you can simply use an interslot call to reach it.
+
+You can use this method to call the BIOS:
+```
+CALSLT:      EQU    #001C
+EXPTBL:      EQU    #FCC1
+
+Call\_Slot:   ld     iy,(EXPTBL-1)       ;BIOS slot in iyh
+             ld     ix,nnnn             ;address of BIOS routine
+             call   CALSLT              ;interslot call
+```
+
+## The SUBROM
+
+You can’t call the SUBROM from MSX-DOS as you would normally, the reason for this is that both `EXTROM` and `CALSLT` use the `IX` register to pass parameters. Calling directly to the SUBROM doesn’t work either, because using an interslot call to call the SUBROM is not allowed per the MSX2 standard. The reason for this, according to _Alex Wulms_ in _MCM 48_, is that some DiskROMs couldn’t handle the the SUBROM being in page 0.
+
+The official means to call the SUBROM from MSX-DOS is by using the following routine, provided by ASCII:
+```
+; CALSUB
+;
+; In: IX = address of routine in MSX2 SUBROM
+;     AF, HL, DE, BC = parameters for the routine
+;
+; Out: AF, HL, DE, BC = depending on the routine
+;
+; Changes: IX, IY, AF', BC', DE', HL'
+;
+; Call MSX2 subrom from MSXDOS. Should work with all versions of MSXDOS.
+;
+; Notice: NMI hook will be changed. This should pose no problem as NMI is
+; not supported on the MSX at all.
+;
+CALSLT:  EQU    #001C
+NMI:     EQU    #0066
+EXTROM:  EQU    #015f
+EXPTBL:  EQU    #fcc1
+H\_NMI:   EQU    #fdd6
+;
+CALSUB:  exx
+         ex     af,af'       ; store all registers
+         ld     hl,EXTROM
+         push   hl
+         ld     hl,#C300
+         push   hl           ; push NOP ; JP EXTROM
+         push   ix
+         ld     hl,#21DD
+         push   hl           ; push LD IX,<entry>
+         ld     hl,#3333
+         push   hl           ; push INC SP; INC SP
+         ld     hl,0
+         add    hl,sp        ; HL = offset of routine
+         ld     a,#C3
+         ld     (H\_NMI),a
+         ld     (H\_NMI+1),hl ; JP <routine> in NMI hook
+         ex     af,af'
+         exx                 ; restore all registers
+         ld     ix,NMI
+         ld     iy,(EXPTBL-1)
+         call   CALLSLT      ; call NMI-hook via NMI entry in ROMBIOS
+                             ; NMI-hook will call SUBROM
+         exx
+         ex     af,af'       ; store all returned registers
+         ld     hl,10
+         add    hl,sp
+         ld     sp,hl        ; remove routine from stack
+         ex     af,af'
+         exx                 ; restore all returned registers
+         ret
+```
+
+~Grauw
+
+© 2025 MSX Assembly Page. MSX is a trademark of MSX Licensing Corporation.