matlab-simulink-mcp 0.1.0__tar.gz

matlab_simulink_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: matlab-simulink-mcp
+Version: 0.1.0
+Summary: An MCP server for allowing LLMs to interact with MATLAB and Simulink
+Author: Rohail
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fastmcp>=2.12.2
+Requires-Dist: platformdirs>=4.4.0
+
+# MATLAB Simulink MCP Server
+
+[![PyPI version](https://img.shields.io/pypi/v/matlab-simulink-mcp.svg)](https://pypi.org/project/matlab-simulink-mcp/)
+[![Python versions](https://img.shields.io/pypi/pyversions/matlab-simulink-mcp.svg)](https://pypi.org/project/matlab-simulink-mcp/)
+
+This [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol) server allows MCP clients (such as Claude Desktop or other LLM-based agents) to interact with **MATLAB** and **Simulink** in real time. It runs locally and is built on top of the [FastMCP 2.0](https://gofastmcp.com/getting-started/welcome) library.
+
+## Features
+
+- Read, write, and run MATLAB code and scripts
+- Parse and interact with Simulink files
+- Access MATLAB workspace variables and outputs (including visualizations)
+- Basic safety layer to prevent execution of unsafe commands (configurable)
+- Non-blocking execution (async MATLAB engine calls)
+- Automatic installation of MATLAB Engine package if unavailable
+
+## Requirements
+
+- **MATLAB** R2022b or later  
+- **Python** 3.10–3.12 (check MATLAB's [supported versions](https://www.mathworks.com/support/requirements/python-compatibility.html))
+
+## Installation
+
+### Option 1 — Download Binary (MATLAB R2025a only)
+
+If you don’t want to interact with Python at all, you can download a prebuilt **exe/app** from the [Releases](../../releases) page and run it directly. In that case you can skip the steps below.
+
+### Option 2 — From Source
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/rohailamalik/matlab-simulink-mcp
+   cd matlab-simulink-mcp
+
+2. Create a Python virtual environment (recommended: [uv](https://pypi.org/project/uv/0.1.32/)):
+
+    ```bash
+    uv venv --python 3.12           # match Python to your MATLAB-supported version
+    source .venv/Scripts/activate   # on macOS/Linux: source .venv/bin/activate
+    uv sync
+    ```
+
+    Without uv, first download a Python version manually:
+
+    ```bash
+    python3.12 -m venv .venv
+    source .venv/bin/activate
+    pip install -r requirements.txt
+    pip install .
+    ```
+
+3. Alternatively, skip step 1, create virtual environment and install directly via PyPI:
+
+    ```bash
+    uv pip install matlab-simulink-mcp
+    # or
+    pip install matlab-simulink-mcp
+    ```
+
+4. On first run, if the MATLAB Engine is not installed, the server will open a console window and guide you through installation.
+
+    - This requires admin permission and the server will request for it.
+    - If you prefer to install manually, install a [matching PyPi version](https://pypi.org/project/matlabengine/#history) or from your [MATLAB installation](https://www.mathworks.com/help/matlab/matlab_external/install-the-matlab-engine-for-python.html).
+
+## Configuration (Claude Desktop)
+
+1. Install [Claude Desktop](https://claude.ai/download).
+
+2. Open Settings → Developer → Edit Config.
+
+3. In the `claude_desktop_config.json`, add or update:
+
+    ```json
+    {
+    "mcpServers": {
+        "MATLAB_Simulink_MCP": {
+            "command": "C:/Data/Research/Doctoral/src/matlab-simulink-mcp/.venv/Scripts/python.exe",
+            "args": ["-m", "matlab_simulink_mcp"]
+            }
+        }
+    }
+    ```
+
+    On macOS/Linux, use `absolute-path-to/.venv/bin/python` in `command`.
+
+    If using the standalone exe/app, just put absolute path to it in `command` and omit args.
+
+    **Note**: Only use `/` or `\\` in the paths, not `\`.
+
+4. Save and restart Claude Desktop. (Ensure it is fully closed in Task Manager/Activity Monitor.)
+
+5. On first launch, the server may open multiple consoles to install MATLAB Engine. Interact with one, complete installation, then restart Claude if needed.
+
+6. Check running status in Settings → Developer, or click the equalizer button in the chat box.
+
+7. The server logs outputs and errors to both Claude's and its own log file. To keep a log file tracking console open, add `--console` in Claude config args.
+
+    - Claude MCP logs (Windows): `%APPDATA%\Claude\logs\mcp-server-MatlabMCP.log`
+    - Claude MCP logs (macOS): `~/Library/Logs/Claude/mcp-server-MatlabMCP.log`
+    - Server logs: written to your user log directory (or configured via `.env`).
+
+## Debugging
+
+FastMCP 2.0 includes an MCP Inspector for manual testing without an LLM client. This launches a UI to send dummy requests directly to the server.
+
+```bash
+cd scripts
+fastmcp dev debugger.py
+```
+
+## Repository Structure
+
+```txt
+
+matlab-simulink-mcp/
+├─ scripts
+│  ├─ debugger.py           # Entry point for MCP inspector
+├─ src/matlab_simulink_mcp/
+│  ├─ data/                 # Data files and resources
+│  ├─ installer/            # MATLAB Engine installer
+│  │  ├─ installer.py
+│  │  ├─ launcher.py
+│  │  └─ win_elevate.py
+│  ├─ functions.py          # Baseline MCP tool functions
+│  ├─ log_utils.py          # Logging utilities
+│  ├─ security.py           # Safety layer for code execution
+│  ├─ server.py             # Main server script
+│  ├─ state.py              # Server lifespan objects (logger, engine)
+│  ├─ __main__.py           # Main entry point
+├─ .env                     # Optional config (e.g. LOG_DIR)
+├─ pyproject.toml           # Project metadata and dependencies
+├─ requirements.txt         # Package dependencies for pip
+├─ uv.lock                  # Package dependencies for uv
+└─ README.md                # This file
+
+```
+
+## FAQ
+
+Q: Which Python version should I install?
+
+A: Match it to the highest Python version supported by your MATLAB release (see MathWorks docs).
+
+Q: The console disappears too quickly!
+
+A: Add `--console` in your Claude config args to keep the server console open.
+
+Q: Multiple installer consoles opened on first run.
+
+A: This is expected if Claude sends multiple startup requests. Complete one installation, then restart Claude Desktop.
+
+## Contributing
+
+Pull requests are welcome! Feel free to submit one or open an issue.

matlab_simulink_mcp-0.1.0/README.md

@@ -0,0 +1,155 @@
+# MATLAB Simulink MCP Server
+
+[![PyPI version](https://img.shields.io/pypi/v/matlab-simulink-mcp.svg)](https://pypi.org/project/matlab-simulink-mcp/)
+[![Python versions](https://img.shields.io/pypi/pyversions/matlab-simulink-mcp.svg)](https://pypi.org/project/matlab-simulink-mcp/)
+
+This [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol) server allows MCP clients (such as Claude Desktop or other LLM-based agents) to interact with **MATLAB** and **Simulink** in real time. It runs locally and is built on top of the [FastMCP 2.0](https://gofastmcp.com/getting-started/welcome) library.
+
+## Features
+
+- Read, write, and run MATLAB code and scripts
+- Parse and interact with Simulink files
+- Access MATLAB workspace variables and outputs (including visualizations)
+- Basic safety layer to prevent execution of unsafe commands (configurable)
+- Non-blocking execution (async MATLAB engine calls)
+- Automatic installation of MATLAB Engine package if unavailable
+
+## Requirements
+
+- **MATLAB** R2022b or later  
+- **Python** 3.10–3.12 (check MATLAB's [supported versions](https://www.mathworks.com/support/requirements/python-compatibility.html))
+
+## Installation
+
+### Option 1 — Download Binary (MATLAB R2025a only)
+
+If you don’t want to interact with Python at all, you can download a prebuilt **exe/app** from the [Releases](../../releases) page and run it directly. In that case you can skip the steps below.
+
+### Option 2 — From Source
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/rohailamalik/matlab-simulink-mcp
+   cd matlab-simulink-mcp
+
+2. Create a Python virtual environment (recommended: [uv](https://pypi.org/project/uv/0.1.32/)):
+
+    ```bash
+    uv venv --python 3.12           # match Python to your MATLAB-supported version
+    source .venv/Scripts/activate   # on macOS/Linux: source .venv/bin/activate
+    uv sync
+    ```
+
+    Without uv, first download a Python version manually:
+
+    ```bash
+    python3.12 -m venv .venv
+    source .venv/bin/activate
+    pip install -r requirements.txt
+    pip install .
+    ```
+
+3. Alternatively, skip step 1, create virtual environment and install directly via PyPI:
+
+    ```bash
+    uv pip install matlab-simulink-mcp
+    # or
+    pip install matlab-simulink-mcp
+    ```
+
+4. On first run, if the MATLAB Engine is not installed, the server will open a console window and guide you through installation.
+
+    - This requires admin permission and the server will request for it.
+    - If you prefer to install manually, install a [matching PyPi version](https://pypi.org/project/matlabengine/#history) or from your [MATLAB installation](https://www.mathworks.com/help/matlab/matlab_external/install-the-matlab-engine-for-python.html).
+
+## Configuration (Claude Desktop)
+
+1. Install [Claude Desktop](https://claude.ai/download).
+
+2. Open Settings → Developer → Edit Config.
+
+3. In the `claude_desktop_config.json`, add or update:
+
+    ```json
+    {
+    "mcpServers": {
+        "MATLAB_Simulink_MCP": {
+            "command": "C:/Data/Research/Doctoral/src/matlab-simulink-mcp/.venv/Scripts/python.exe",
+            "args": ["-m", "matlab_simulink_mcp"]
+            }
+        }
+    }
+    ```
+
+    On macOS/Linux, use `absolute-path-to/.venv/bin/python` in `command`.
+
+    If using the standalone exe/app, just put absolute path to it in `command` and omit args.
+
+    **Note**: Only use `/` or `\\` in the paths, not `\`.
+
+4. Save and restart Claude Desktop. (Ensure it is fully closed in Task Manager/Activity Monitor.)
+
+5. On first launch, the server may open multiple consoles to install MATLAB Engine. Interact with one, complete installation, then restart Claude if needed.
+
+6. Check running status in Settings → Developer, or click the equalizer button in the chat box.
+
+7. The server logs outputs and errors to both Claude's and its own log file. To keep a log file tracking console open, add `--console` in Claude config args.
+
+    - Claude MCP logs (Windows): `%APPDATA%\Claude\logs\mcp-server-MatlabMCP.log`
+    - Claude MCP logs (macOS): `~/Library/Logs/Claude/mcp-server-MatlabMCP.log`
+    - Server logs: written to your user log directory (or configured via `.env`).
+
+## Debugging
+
+FastMCP 2.0 includes an MCP Inspector for manual testing without an LLM client. This launches a UI to send dummy requests directly to the server.
+
+```bash
+cd scripts
+fastmcp dev debugger.py
+```
+
+## Repository Structure
+
+```txt
+
+matlab-simulink-mcp/
+├─ scripts
+│  ├─ debugger.py           # Entry point for MCP inspector
+├─ src/matlab_simulink_mcp/
+│  ├─ data/                 # Data files and resources
+│  ├─ installer/            # MATLAB Engine installer
+│  │  ├─ installer.py
+│  │  ├─ launcher.py
+│  │  └─ win_elevate.py
+│  ├─ functions.py          # Baseline MCP tool functions
+│  ├─ log_utils.py          # Logging utilities
+│  ├─ security.py           # Safety layer for code execution
+│  ├─ server.py             # Main server script
+│  ├─ state.py              # Server lifespan objects (logger, engine)
+│  ├─ __main__.py           # Main entry point
+├─ .env                     # Optional config (e.g. LOG_DIR)
+├─ pyproject.toml           # Project metadata and dependencies
+├─ requirements.txt         # Package dependencies for pip
+├─ uv.lock                  # Package dependencies for uv
+└─ README.md                # This file
+
+```
+
+## FAQ
+
+Q: Which Python version should I install?
+
+A: Match it to the highest Python version supported by your MATLAB release (see MathWorks docs).
+
+Q: The console disappears too quickly!
+
+A: Add `--console` in your Claude config args to keep the server console open.
+
+Q: Multiple installer consoles opened on first run.
+
+A: This is expected if Claude sends multiple startup requests. Complete one installation, then restart Claude Desktop.
+
+## Contributing
+
+Pull requests are welcome! Feel free to submit one or open an issue.

matlab_simulink_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "matlab-simulink-mcp"
+version = "0.1.0"
+description = "An MCP server for allowing LLMs to interact with MATLAB and Simulink"
+authors = [
+  { name = "Rohail"}
+]
+license = { text = "MIT" }
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent"
+]
+
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.10,<3.13"
+dependencies = [
+    "fastmcp>=2.12.2",
+    "platformdirs>=4.4.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"matlab_simulink_mcp" = ["data/*.txt", "data/*.json", "data/helpers/*.py"]
+
+[project.scripts]
+matlab_simulink_mcp = "matlab_simulink_mcp.__main__:main"

matlab_simulink_mcp-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

matlab_simulink_mcp-0.1.0/src/matlab_simulink_mcp/__main__.py

@@ -0,0 +1,13 @@
+import argparse
+import matlab_simulink_mcp.server as server
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--console", action="store_true", help="Keep console open.")
+    args = parser.parse_args()
+
+    server.console = args.console
+    server.run()
+
+if __name__ == "__main__":
+    main()

matlab_simulink_mcp-0.1.0/src/matlab_simulink_mcp/data/blacklist.txt

@@ -0,0 +1,39 @@
+# The commands mentioned in this file are not allowed to be used by the LLM for safety reasons.
+# The LLM is also not allowed to use absolute paths (and thus access anything not on MATLAB path).
+# ! is only blocked in the code when used at the beginning of the line i.e. as a proper command
+
+!
+eval
+rehash
+feval
+system
+unix
+dos
+builtin
+str2func
+perl
+python
+pyenv
+py.
+javaobject
+javamethod
+javamethodedt
+javaclasspath
+javaaddpath
+matlab.desktop.editor.opendocument
+matlab.desktop.editor.save
+addpath
+rmpath
+cd
+userpath
+path
+savepath
+restoredefaultpath
+genpath
+which
+what
+matlabroot
+uigetdir
+uigetfile
+uiopen
+uiputfile