@nataliapc/mcp-openmsx 1.1.13 → 1.1.14

package/dist/server.js

@@ -6,7 +6,7 @@
  * through TCL commands via stdio.
  *
  * @package @nataliapc/mcp-openmsx
- * @version 1.1.13
+ * @version 1.1.14
  * @author Natalia Pujol Cremades (@nataliapc)
  * @license GPL2
  */
@@ -18,12 +18,11 @@ import { randomUUID } from "node:crypto";
 import { z } from "zod";
 import express from "express";
 import fs from "fs/promises";
-import mime from "mime-types";
 import path from "path";
 import { openMSXInstance } from "./openmsx.js";
-import { encodeTypeText, isErrorResponse, getResponseContent } from "./utils.js";
+import { fetchCleanWebpage, addFileExtension, listResourcesDirectory, encodeTypeText, isErrorResponse, getResponseContent } from "./utils.js";
 // Version info for CLI
-const PACKAGE_VERSION = "1.1.13";
+const PACKAGE_VERSION = "1.1.14";
 const resourcesDir = path.join(path.dirname(new URL(import.meta.url).pathname), "../resources");
 // Defaults for openMSX paths
 var OPENMSX_EXECUTABLE = 'openmsx';
@@ -864,22 +863,22 @@ The parameter scrbasename is the name of the filename (without path) to save the
     });
     // ============================================================================
     // MSX Documentation resources
-    const resdocs = (await listResourcesDirectory()).sort();
+    const resdocs = (await listResourcesDirectory(resourcesDir)).sort();
     for (let index = 0; index < resdocs.length; index++) {
         const sectionName = resdocs[index];
         const tocFile = path.join(resourcesDir, `${sectionName}/toc.json`);
         const tocContent = JSON.parse(await fs.readFile(tocFile, 'utf8'));
         tocContent.toc.forEach((item, itemIndex) => {
-            const itemName = item.uri.split('/').pop() || '';
+            const itemName = path.parse(item.uri.split('/').pop()).name || '';
             server.registerResource(
             // Name of the resource (used to call it)
-            `msxdocs_${sectionName}_${itemName}`, 
+            `msxdocs_${sectionName}_${item.title.replace(/[^a-z0-9]+/gi, '_').toLowerCase()}`, 
             // Resource URI template
             item.uri, 
             // Metadata for the resource
             {
-                title: item.title || `MSX Documentation '${sectionName}' - ${itemName}`,
-                description: item.description || `Documentation for MSX resource '${sectionName}' - ${itemName}`,
+                title: item.title || `MSX Documentation '${sectionName}': ${itemName}`,
+                description: item.description || `Documentation for MSX resource '${sectionName}': ${itemName}`,
                 mimeType: item.mimeType || 'text/markdown',
             }, 
             // Handler for the resource (function to be executed when the resource is called)
@@ -889,14 +888,11 @@ The parameter scrbasename is the name of the filename (without path) to save the
                 if (uri.href.startsWith('http://') || uri.href.startsWith('https://')) {
                     // Fetch the resource from the URL
                     try {
-                        resourceContent = await fetch(uri.href).then(response => {
-                            mimeType = response.headers.get('content-type') || 'text/plain';
-                            return response.text();
-                        }) || 'Error downloading resource content';
+                        [resourceContent, mimeType] = await fetchCleanWebpage(uri.href);
                     }
                     catch (error) {
                         // Throw exception (MCP protocol requirement)
-                        throw new Error(`Error fetching resource from ${uri.href}: ${error instanceof Error ? error.message : String(error)}`);
+                        throw error;
                     }
                 }
                 else {
@@ -922,16 +918,16 @@ The parameter scrbasename is the name of the filename (without path) to save the
         });
     }
     ;
-    server.resource("msxdocs_msxorg_wiki", new ResourceTemplate("msxdocs://msxorg_wiki/{section}", {
+    server.resource("msxdocs_basic_wiki", new ResourceTemplate("msxdocs://basic_wiki/{instruction}", {
         list: undefined,
         complete: {
-            section: (value) => [
+            instruction: (value) => [
                 "ABS()", "AND", "ASC()", "ATN()", "AUTO", "BASE()", "BEEP", "BIN$()", "BLOAD", "BSAVE", "CALL", "CALL ADJUST", "CALL PAUSE", "CALL PCMPLAY", "CALL PCMREC",
                 "CDBL()", "CHR$()", "CINT()", "CIRCLE", "CLEAR", "CLOAD", "CLOAD?", "CLOSE", "CLS", "COLOR", "COLOR=", "COLOR", "COLOR", "CONT", "COPY", "COPY", "COS()", "CSAVE",
                 "CSNG()", "CSRLIN", "DATA", "DEFDBL", "DEF FN", "DEFINT", "DEFSNG", "DEFSTR", "DEF USR", "DELETE", "DIM", "DRAW", "ELSE", "END", "EOF()", "EQV", "ERASE", "ERL", "ERR",
-                "ERROR", "EXP()", "FIX()", "FN	MSX1", "FOR...NEXT", "FRE()", "GET DATE", "GET TIME", "GOSUB", "GOTO", "HEX$()", "IF...GOTO...ELSE", "IF...THEN...ELSE",
-                "IMP", "INKEY$", "INP()", "INPUT", "INPUT$()", "INSTR()", "INT()", "INTERVAL", "KEY", "KEY()", "LEFT$()", "LEN()", "LET", "LINE", "LINE INPUT", "LIST",
-                "LLIST", "LOAD", "LOCATE", "LOG()", "LPOS()", "LPRINT", "MAXFILES", "MERGE", "MID$()", "MOD", "MOTOR", "NEW", "NOT", "OCT$()", "ON...GOSUB", "ON...GOTO",
+                "ERROR", "EXP()", "FIX()", "FN", "FOR...NEXT", "FRE()", "GET DATE", "GET TIME", "GOSUB", "GOTO", "HEX$()", "IF...GOTO...ELSE", "IF...THEN...ELSE", "IMP",
+                "INKEY$", "INP()", "INPUT", "INPUT$()", "INSTR()", "INT()", "INTERVAL", "KEY", "KEY()", "LEFT$()", "LEN()", "LET", "LINE", "LINE INPUT", "LIST", "LLIST",
+                "LOAD", "LOCATE", "LOG()", "LPOS()", "LPRINT", "MAXFILES", "MERGE", "MID$()", "MOD", "MOTOR", "NEW", "NOT", "OCT$()", "ON...GOSUB", "ON...GOTO",
                 "ON ERROR GOTO", "ON INTERVAL GOSUB", "ON KEY GOSUB", "ON SPRITE GOSUB", "ON STOP GOSUB", "ON STRIG GOSUB", "OPEN", "OR", "OUT", "PAD()", "PAINT", "PDL()",
                 "PEEK()", "PLAY", "PLAY()", "POINT", "POKE", "POS()", "PRESET", "PRINT", "PSET", "PUT KANJI", "PUT SPRITE", "READ", "REM", "RENUM", "RESTORE", "RESUME",
                 "RETURN", "RIGHT$()", "RND()", "RUN", "SAVE", "SCREEN", "SET ADJUST", "SET BEEP", "SET DATE", "SET PAGE", "SET PASSWORD", "SET PROMPT", "SET SCREEN",
@@ -941,25 +937,20 @@ The parameter scrbasename is the name of the filename (without path) to save the
             ],
         },
     }), {
-        title: "BASIC MSX Documentation",
-        description: "Documentation about all the standard MSX-BASIC instructions.",
+        title: "MSX BASIC Instructions Documentation",
+        description: "Documentation about all the standard MSX BASIC instructions from www.msx.org",
         mimeType: "text/html",
     }, async (uri, variables) => {
-        const section = variables.section.replace(/ /g, '_').replace(/\?/g, '%3F').replace(/=/g, '%3D');
-        const url = `https://www.msx.org/wiki/${section}`;
+        const instruction = variables.instruction.replace(/ /g, '_').replace(/\?/g, '%3F').replace(/=/g, '%3D');
+        const url = `https://www.msx.org/wiki/${instruction}`;
         let resourceContent;
         let mimeType;
         try {
-            resourceContent = await fetch(url).then(response => {
-                mimeType = response.headers.get('content-type') || 'text/plain';
-                return response.text();
-            }) || 'Error downloading resource content';
-            // Remove script, style, and link tags from the content
-            resourceContent = resourceContent.replace(/<script\b[^>]*>[\s\S]*?<\/script>|<style\b[^>]*>[\s\S]*?<\/style>|<link\b[^>]*\/?>/gi, '');
+            [resourceContent, mimeType] = await fetchCleanWebpage(url);
         }
         catch (error) {
             // Throw exception (MCP protocol requirement)
-            throw new Error(`Error fetching resource "${uri}" from "${url}": ${error instanceof Error ? error.message : String(error)}`);
+            throw error;
         }
         return {
             contents: [{
@@ -970,41 +961,6 @@ The parameter scrbasename is the name of the filename (without path) to save the
         };
     });
 }
-async function addFileExtension(filePath) {
-    // Get directory and filename
-    const directory = path.dirname(filePath);
-    const filename = path.basename(filePath);
-    try {
-        // Get all files in directory that start with our filename
-        const files = await fs.readdir(directory);
-        const matchingFiles = files.filter(file => file.startsWith(filename));
-        if (matchingFiles.length > 0) {
-            const fileFound = path.join(directory, matchingFiles[0]);
-            return [
-                mime.lookup(fileFound) || 'text/plain',
-                fileFound
-            ];
-        }
-    }
-    catch (error) {
-        console.error('Error reading directory:', error);
-    }
-    // Return original if no matches found
-    return ['text/plain', filePath];
-}
-async function listResourcesDirectory() {
-    try {
-        const directories = await fs.readdir(resourcesDir, { withFileTypes: true });
-        const folderNames = directories
-            .filter(dirent => dirent.isDirectory())
-            .map(dirent => dirent.name);
-        return folderNames;
-    }
-    catch (error) {
-        console.error("Error reading resources directory:", error);
-        return [];
-    }
-}
 // ============================================================================
 // Cleanup handlers for graceful shutdown of MCP server
 // Ensure openMSX emulator is closed when MCP server stops

package/dist/utils.js

@@ -5,6 +5,8 @@
  * @license GPL2
  */
 import fs from 'fs/promises';
+import path from 'path';
+import mime from 'mime-types';
 /**
  * Extract description from XML file
  * @param filePath - Full path to the XML file
@@ -21,6 +23,73 @@ export async function extractDescriptionFromXML(filePath) {
         return 'Error reading description';
     }
 }
+/**
+ * Add file extension to a file path if it exists in the same directory and determine its MIME type
+ * @param filePath - Full path to the file excluding extension
+ * @returns Promise<string[]> - An array containing the MIME type and the full file path with extension
+ */
+export async function addFileExtension(filePath) {
+    // Get directory and filename
+    const directory = path.dirname(filePath);
+    const filename = path.basename(filePath);
+    try {
+        // Get all files in directory that start with our filename
+        const files = await fs.readdir(directory);
+        const matchingFiles = files.filter(file => file.startsWith(filename));
+        if (matchingFiles.length > 0) {
+            const fileFound = path.join(directory, matchingFiles[0]);
+            return [
+                mime.lookup(fileFound) || 'text/plain',
+                fileFound
+            ];
+        }
+    }
+    catch (error) {
+        console.error('Error reading directory:', error);
+    }
+    // Return original if no matches found
+    return ['text/plain', filePath];
+}
+/**
+ * List all folders in the resources directory
+ * @param resourcesDir - Path to the resources directory
+ * @returns Promise<string[]> - List of folder names in the resources directory
+ */
+export async function listResourcesDirectory(resourcesDir) {
+    try {
+        const directories = await fs.readdir(resourcesDir, { withFileTypes: true });
+        const folderNames = directories
+            .filter(dirent => dirent.isDirectory())
+            .map(dirent => dirent.name);
+        return folderNames;
+    }
+    catch (error) {
+        console.error("Error reading resources directory:", error);
+        return [];
+    }
+}
+/**
+ * Fetch a webpage and return its content (without scripts, styles, or links) and its MIME type
+ * @param url - URL of the webpage to fetch
+ * @returns Promise<[string, string]> - A tuple containing the webpage content and its MIME type
+ */
+export async function fetchCleanWebpage(url) {
+    let resourceContent;
+    let mimeType = 'text/plain';
+    try {
+        resourceContent = await fetch(url).then(response => {
+            mimeType = response.headers.get('content-type') || 'text/plain';
+            return response.text();
+        }) || 'Error downloading content';
+        // Remove script, style, and link tags from the content
+        resourceContent = resourceContent.replace(/<script\b[^>]*>[\s\S]*?<\/script>|<style\b[^>]*>[\s\S]*?<\/style>|<link\b[^>]*\/?>/gi, '');
+    }
+    catch (error) {
+        // Throw exception (MCP protocol requirement)
+        throw new Error(`Error fetching resource from ${url}: ${error instanceof Error ? error.message : String(error)}`);
+    }
+    return [resourceContent, mimeType];
+}
 /**
  * Decode HTML entities in a string to plain text
  * @param text - String containing HTML entities

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nataliapc/mcp-openmsx",
-  "version": "1.1.13",
+  "version": "1.1.14",
   "description": "Model context protocol server for openMSX automation and control",
   "main": "dist/server.js",
   "type": "module",