@nataliapc/mcp-openmsx 1.2.3 → 1.2.5

package/README.md

@@ -1,6 +1,6 @@
 # MCP-openMSX
 
-*"Orchestrating a binary opera where AI conducts, MCP interprets, and openMSX acts as the 8-bit diva."*
+_"Orchestrating a binary opera where AI conducts, MCP interprets, and openMSX acts as the 8-bit diva."_
 
 [![Built by NataliaPC](https://img.shields.io/badge/Built%20by-NataliaPC-blue)](https://github.com/nataliapc)
 [![License](https://img.shields.io/badge/License-GPL2-blue.svg)](https://github.com/nataliapc/mcp-openmsx/blob/main/LICENSE)
@@ -13,13 +13,18 @@ A [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) s
 
 This server provides comprehensive tools for MSX software development, testing, and automation through standardized MCP protocols.
 
+
+> 🎁🎁 _If you find this project useful, please consider making a donation: [PAYPAL Link](https://www.paypal.com/donate/?hosted_button_id=9X268YDDS9SYC)_
+
+---
+
 ## Table of Contents
 
 - [Project overview](#project-overview)
 - [Architecture](#architecture)
 - [Available MCP Tools](#available-mcp-tools)
 - [Available MCP Resources](#available-mcp-resources)
-- [**Quick Start**](#quick-start)
+- ⚡ [Quick Start](#quick-start)
   - [Quick installation with **VSCode**](#quick-installation-with-vscode)
   - [Basic installation with **Claude Desktop**](#basic-installation-with-claude-desktop)
   - [Environment Variables](#environment-variables)
@@ -28,6 +33,7 @@ This server provides comprehensive tools for MSX software development, testing,
 - [License](#license)
 - [Support](#support)
 - [Contributing](#contributing)
+- 🌟 [More stars!](#more-stars) 🌟
 
 ## Project Overview
 
@@ -104,7 +110,7 @@ The MCP server translates high-level natural language commands from your Copilot
 - `debug_breakpoints`: Breakpoint management: _`create`, `remove`, `list`_.
 
 ### Automation Tools
-- `emu_keyboard`: Send text input to emulator: _`sendText`_.
+- `emu_keyboard`: Send text or key combinations to emulator: _`sendText`, `sendKeyCombo`_.
 - `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 instruction.
@@ -154,7 +160,8 @@ And books and manuals:
 
 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.
+> [!IMPORTANT]  
+> The rights to these resources belong to their respective authors and are distributed under the licenses they have defined.
 
 ## Quick Start
 
@@ -165,9 +172,11 @@ You can use this MCP server in this basic way with the [precompiled NPM package]
 [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_MCP_Server-0098FF?style=flat&logo=visualstudiocode&logoColor=ffffff)](https://insiders.vscode.dev/redirect/mcp/install?name=mcp-openmsx&config=%7B%22name%22%3A%22mcp-openmsx%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40nataliapc%2Fmcp-openmsx%22%5D%7D)
 
 Steps to install the MCP server in VSCode:
-* Install [Github Copilot extension](https://code.visualstudio.com/docs/copilot/overview)
-* Use the **Install MCP Server** button above to install the MCP server in your VSCode settings.
-* Or add to your workspace a file `.vscode/mcp.json` with the json configuration below.
+1. Install [Github Copilot extension](https://code.visualstudio.com/docs/copilot/overview)
+2. [Install nodejs](https://nodejs.org/en/download) (`npx` command must be available in your PATH).
+3. Install de MCP Server:
+    - Use the **Install MCP Server** button above to install the MCP server in your VSCode settings.
+    - Or add to your _workspace folder_ a file named `.vscode/mcp.json` with the json configuration below.
 
 ### STDIO mode (recommended)
 
@@ -185,7 +194,8 @@ Steps to install the MCP server in VSCode:
 }
 ```
 
-**Note:** Environment variables are optional. Customize them as you need.
+> [!NOTE]  
+> Environment variables are optional. Customize them as you need.
 
 ### Streamed HTTP mode (more advanced)
 
@@ -201,7 +211,8 @@ Steps to install the MCP server in VSCode:
 }
 ```
 
-**Note:** The MCP HTTP Server must be running standalone in the same computer or in another (`make run_http`).
+> [!NOTE]  
+> The MCP HTTP Server must be running standalone in the same computer or in another (`make run_http`).
 
 ### Basic Installation with Claude Desktop
 
@@ -223,7 +234,8 @@ Edit it to include the following JSON entry:
 }
 ```
 
-**Note:** Environment variables are optional. Customize them as you need.
+> [!NOTE]  
+> Environment variables are optional. Customize them as you need.
 
 ### Environment Variables
 
@@ -236,11 +248,13 @@ Edit it to include the following JSON entry:
 | `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` |
+| `MCP_ALLOWED_ORIGINS` | Comma-separated list of allowed origins for HTTP transport | Empty for all allowed | `http://localhost,http://mydomain.com` |
 
 
 ## Advanced Manual Usage
 
-This is not needed for using the MCP server, but if you want to install it manually, follow these steps.
+> [!IMPORTANT]  
+> This is not needed for using the MCP server, but if you want to install it manually, follow these steps.
 
 Currently, the MCP server requires Linux to be compiled. It has not been tested on Windows or macOS, although it will likely work on the latter as well.
 
@@ -261,6 +275,7 @@ 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
+export MCP_ALLOWED_ORIGINS="http://localhost,http://mydomain.com"
 ```
 
 ### As MCP Server (stdio)
@@ -279,7 +294,8 @@ mcp-openmsx http
 
 ## Development
 
-This is not needed for using the MCP server, but if you want to contribute or modify the code, follow these steps.
+> [!IMPORTANT]  
+> This is not needed for using the MCP server, but if you want to contribute or modify the code, follow these steps.
 
 ### Prerequisites to build
 
@@ -316,4 +332,12 @@ If you need help, or have questions or suggestions, please open an issue on the
 
 Contributions are welcome! Please feel free to submit a Pull Request.
 
+
+## More stars!
+
+Please give us a star on [GitHub](https://github.com/nataliapc/mcp-openmsx) if you like this project.
+
+[![Star History Chart](https://api.star-history.com/svg?repos=nataliapc/mcp-openmsx&type=Date&theme=dark)](https://www.star-history.com/#nataliapc/mcp-openmsx&Date)
+## Star History
+
 ---