matlab-simulink-mcp 0.1.0__tar.gz → 0.1.2__tar.gz

matlab_simulink_mcp-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rohail Malik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

matlab_simulink_mcp-0.1.2/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: matlab-simulink-mcp
+Version: 0.1.2
+Summary: An MCP server for allowing LLMs to interact with MATLAB and Simulink
+Author: Rohail
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastmcp>=2.12.2
+Requires-Dist: platformdirs>=4.4.0
+Dynamic: license-file
+
+# MATLAB Simulink MCP Server
+
+This Model Context Protocol (MCP) 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, is built on top of the [FastMCP 2.0](https://gofastmcp.com/getting-started/welcome) library, and uses MATLAB Engine for Python API to communicate with MATLAB and Simulink.
+
+## 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
+
+1. Install using:
+
+    ```bash
+    uv pip install matlab-simulink-mcp
+    # or
+    pip install matlab-simulink-mcp
+    ```
+
+2. On the 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": "absolute-path-to/.venv/Scripts/python.exe", // absolute path to your venv/global environment executable
+            "args": ["-m", "matlab_simulink_mcp"]
+            }
+        }
+    }
+    ```
+
+    On macOS/Linux, use `absolute-path-to/.venv/bin/python` in `command`.
+
+    **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 Claude's 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. It launches a UI to send dummy requests directly to the server.
+
+To use it, import `mcp` from `matlab_simulink_mcp.server` into a script and run the script using `fastmcp dev script_name.py`

{matlab_simulink_mcp-0.1.0 → matlab_simulink_mcp-0.1.2}/README.md

@@ -3,7 +3,7 @@
 [![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.
+This Model Context Protocol (MCP) 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, is built on top of the [FastMCP 2.0](https://gofastmcp.com/getting-started/welcome) library, and uses MATLAB Engine for Python API to communicate with MATLAB and Simulink.
 
 ## Features
 
@@ -33,7 +33,7 @@ If you don’t want to interact with Python at all, you can download a prebuilt
    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/)):
+2. Create a Python virtual environment ([uv](https://pypi.org/project/uv/0.1.32/) is recommended):
 
     ```bash
     uv venv --python 3.12           # match Python to your MATLAB-supported version
@@ -41,11 +41,11 @@ If you don’t want to interact with Python at all, you can download a prebuilt
     uv sync
     ```
 
-    Without uv, first download a Python version manually:
+    Without uv, first download a Python version manually, then run:
 
     ```bash
-    python3.12 -m venv .venv
-    source .venv/bin/activate
+    python3.12 -m venv .venv        # match Python to your MATLAB-supported version
+    source .venv/Scripts/activate   # on macOS/Linux: source .venv/bin/activate
     pip install -r requirements.txt
     pip install .
     ```
@@ -58,7 +58,7 @@ If you don’t want to interact with Python at all, you can download a prebuilt
     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.
+4. On the 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).
@@ -75,7 +75,7 @@ If you don’t want to interact with Python at all, you can download a prebuilt
     {
     "mcpServers": {
         "MATLAB_Simulink_MCP": {
-            "command": "C:/Data/Research/Doctoral/src/matlab-simulink-mcp/.venv/Scripts/python.exe",
+            "command": "absolute-path-to/.venv/Scripts/python.exe", // absolute path to your venv/global environment executable
             "args": ["-m", "matlab_simulink_mcp"]
             }
         }
@@ -92,7 +92,7 @@ If you don’t want to interact with Python at all, you can download a prebuilt
 
 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.
+6. Check running status in Settings → Developer, or click the equalizer button in Claude's 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.
 
@@ -102,7 +102,7 @@ If you don’t want to interact with Python at all, you can download a prebuilt
 
 ## 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.
+FastMCP 2.0 includes an MCP Inspector for manual testing without an LLM client. It launches a UI to send dummy requests directly to the server.
 
 ```bash
 cd scripts
@@ -138,17 +138,17 @@ matlab-simulink-mcp/
 
 ## 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: 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!
+- Q: The console disappears too quickly!
 
-A: Add `--console` in your Claude config args to keep the server console open.
+- A: Add `--console` in your Claude config args to keep the server console open.
 
-Q: Multiple installer consoles opened on first run.
+- 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.
+- A: This is expected if Claude sends multiple startup requests. Complete one installation, then restart Claude Desktop.
 
 ## Contributing
 

matlab_simulink_mcp-0.1.2/README_pypi.md

@@ -0,0 +1,73 @@
+# MATLAB Simulink MCP Server
+
+This Model Context Protocol (MCP) 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, is built on top of the [FastMCP 2.0](https://gofastmcp.com/getting-started/welcome) library, and uses MATLAB Engine for Python API to communicate with MATLAB and Simulink.
+
+## 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
+
+1. Install using:
+
+    ```bash
+    uv pip install matlab-simulink-mcp
+    # or
+    pip install matlab-simulink-mcp
+    ```
+
+2. On the 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": "absolute-path-to/.venv/Scripts/python.exe", // absolute path to your venv/global environment executable
+            "args": ["-m", "matlab_simulink_mcp"]
+            }
+        }
+    }
+    ```
+
+    On macOS/Linux, use `absolute-path-to/.venv/bin/python` in `command`.
+
+    **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 Claude's 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. It launches a UI to send dummy requests directly to the server.
+
+To use it, import `mcp` from `matlab_simulink_mcp.server` into a script and run the script using `fastmcp dev script_name.py`

matlab_simulink_mcp-0.1.2/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "matlab-simulink-mcp"
+version = "0.1.2"
+description = "An MCP server for allowing LLMs to interact with MATLAB and Simulink"
+authors = [
+  { name = "Rohail"}
+]
+license = { text = "MIT" }
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Scientific/Engineering",
+  "Topic :: Software Development :: Libraries :: Python Modules"
+]
+readme = { file = "README_pypi.md", content-type = "text/markdown" }
+requires-python = ">=3.10,<3.13"
+dependencies = [
+    "fastmcp>=2.12.2",
+    "platformdirs>=4.4.0",
+]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"matlab_simulink_mcp" = ["data/*.txt", "data/*.json", "data/helpers/*.m"]
+
+[project.scripts]
+matlab_simulink_mcp = "matlab_simulink_mcp.__main__:main"
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple"
+publish-url = "https://upload.pypi.org/legacy/"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple"
+publish-url = "https://test.pypi.org/legacy/"
+

matlab_simulink_mcp-0.1.2/src/matlab_simulink_mcp/data/helpers/describe_system.m

@@ -0,0 +1,64 @@
+function system_data = describe_system(system_path, main_system, open)
+
+% This function returns the information about a system layout as a JSON. 
+% It's still problematic with Simscape because some blocks such as
+% SolverConfiguration and PS-Simulink Convertor are defined internally as
+% SubSystems instead of Simscape blocks.
+
+load_system(main_system)
+
+if open
+    open_system(system_path);
+end
+
+blocks = find_system(system_path, 'SearchDepth', 1, 'Type', 'Block');
+
+    elements = {};
+    connections = {};
+
+    for i = 1:length(blocks)
+
+        blk = blocks{i};
+
+        if strcmp(blk, system_path) % Skips the subsystem itself if it is being asked for
+            continue;
+        end 
+
+        blk_source = get_param(blk, 'ReferenceBlock');
+
+        element = struct();
+        element.Name = get_param(blk, 'Name');
+        element.Type = get_param(blk, 'BlockType');
+        
+        if blk_source ~= ""
+            element.Source = blk_source;
+        end 
+
+        if ~strcmp(element.Type, "SimscapeBlock") && ~strcmp(element.Type, "SubSystem") && ~contains("Port", "port", 'IgnoreCase', true)
+            % It's a built-in simulink block
+            if blk_source ~= ""
+                element.Source = ['built-in/' element.Type];
+            end 
+            element.Type = "Block";
+                     
+        end
+
+        [inports, outports, simscapeports, connects] = get_ports_connections(blk, element.Name, element.Type);
+        
+        if ~isempty(inports), element.Inports = inports; end
+        if ~isempty(outports), element.Outports = outports; end
+        if ~isempty(simscapeports), element.SimscapePorts = simscapeports; end
+        if ~isempty(connects), connections = [connections, connects]; end
+
+        elements{end+1} = element;
+
+    end
+
+    system = struct();
+    system.Elements = elements;
+    system.Connections = connections; 
+
+    %system_data = jsonencode(system);
+    system_data = system;
+
+end

matlab_simulink_mcp-0.1.2/src/matlab_simulink_mcp/data/helpers/format_system.m

@@ -0,0 +1,21 @@
+function format_system()
+%function result = format_system(system_path, main_system, arrange)
+%load_system(main_system)
+
+%if arrange
+%    Simulink.BlockDiagram.arrangeSystem(system_path);
+%end 
+
+systems = find_system('type','block_diagram');
+
+for i = 1:numel(systems)
+    sys = systems{i};
+    hLines = find_system(sys, 'FindAll', 'on', 'Type', 'line', 'Connected', 'off');
+    delete_line(hLines);
+end
+
+%hLines = find_system(system_path, 'SearchDepth', 1, 'FindAll', 'on', 'Type', 'Line', 'Connected', 'off');
+%delete_line(hLines);
+%result = "Success";
+
+

matlab_simulink_mcp-0.1.2/src/matlab_simulink_mcp/data/helpers/get_images.m

@@ -0,0 +1,14 @@
+function cwds = get_images()
+    figs = findall(0, 'type', 'figure');  
+    num = numel(figs);
+    if num == 0 
+        cwds = {};     
+    else
+        cwds = cell(1, num);
+        for k = 1:num
+            filename = sprintf('temp_plot_%d.png', k);
+            saveas(figs(k), filename);
+            cwds{k} = fullfile(pwd, filename);
+        end 
+    end
+end

matlab_simulink_mcp-0.1.2/src/matlab_simulink_mcp/data/helpers/get_ports_connections.m

@@ -0,0 +1,124 @@
+function [inports, outports, simscapeports, connections] = get_ports_connections(blk, blk_name, blk_type)
+
+% This function gets, for a given block, its name and type, the names (if
+% it's a subsystem) and tags of its ports and connections.
+
+inports = {};
+outports = {};
+simscapeports = {};
+connections = {};
+
+is_subsystem = strcmp(blk_type, 'SubSystem');
+PC = get_param(blk, 'PortConnectivity');
+
+% First create a list of the port names. Unfortunately, this is only
+% possible for subsystems since only port blocks can have names, not ports themselves
+
+% For non-Simscape port blocks, the order through find_system is the
+% same as the ports in PortConnectivity matrix
+
+% For Simscape port blocks, the order through find_system is based on the
+% number of the port (displayed visually at the center of PortConnection block)
+% But in PortConnectivity matrix, the ports on Left are listed first and then right
+% Within each type, the order follows the visual number of the port
+% So we first get port blocks on left, and then right, and then concenate all of them
+
+if is_subsystem
+    
+    SimulinkPortBlks = find_system(blk, 'Regexp', 'on', 'BlockType', ...
+        'Inport|Outport|EnablePort|TriggerPort|ResetPort|ActionPort');
+    
+    PhyPortBlksLefts = find_system(blk, 'Regexp', 'on', 'BlockType', 'PMIOPort', 'Side', 'Left');
+    PhyPortBlksRights = find_system(blk, 'Regexp', 'on', 'BlockType', 'PMIOPort', 'Side', 'Right');
+
+    PortBlks = [SimulinkPortBlks(:); PhyPortBlksLefts(:); PhyPortBlksRights(:)];
+    PortNames = get_param(PortBlks, 'Name');
+
+    if isempty(PortNames)
+        is_subsystem = 0;
+    end 
+
+end 
+
+% Some Simscape blocks e.g. PS-Simulink Convertor are defined internally as
+% SubSystems instead of Simscape blocks. So the if condition above ensures
+% that if such blocks are counted as subsystems and port names gathered
+% (which would be empty), we flag the block manually as not a subsystem
+
+% Loop through the ports. For each port, create a strcuture with tag and
+% name (if the element is a subsystem) fields
+% For connections, first get the Simscape ports (i.e. LConnX and % RConnX).
+% For these ports, DstPort contains the handle of the attached port. So we
+% get the DstBlock's PortHandles through its handle, and then get its tag
+% For non-simscape ports, the DstPort contains -1 the field index of the
+% attached port in the DstBlock's PortConnectivity matrix.
+% Also, only consider outports for these ports as they are easily
+% distinguishable through an empty SrcBlock. For inports, the connections
+% will be gathered when the script is ran for the connected block. This
+% also prevents repitition. Inports also include ports such as trigger etc
+
+for i = 1:length(PC)
+    
+    Port = PC(i).Type;  
+    PortStr = struct('tag', Port);
+    if is_subsystem
+        try
+            PortStr.name = PortNames{i};
+        catch 
+        end 
+    end
+
+    if contains(Port, {'LConn', 'RConn'})
+        
+        simscapeports{end+1} = PortStr;
+
+        for j = 1:length(PC(i).DstBlock)
+            
+            DstBlockHandle = PC(i).DstBlock(j);
+            DstBlockName = get_param(DstBlockHandle, 'Name');
+            
+            DstPortHandle = PC(i).DstPort(j);
+            DstPH = get_param(DstBlockHandle, 'PortHandles');
+               
+            idxL = find(DstPH.LConn == DstPortHandle, 1);
+            idxR = find(DstPH.RConn == DstPortHandle, 1);
+                
+            if ~isempty(idxL)
+                DstPort = sprintf('LConn%d', idxL);
+            else
+                DstPort = sprintf('RConn%d', idxR);
+            end
+                
+            connections{end+1} = struct('from', sprintf("%s/%s", blk_name, Port), ...
+                'to', sprintf("%s/%s", DstBlockName, DstPort));
+        
+        end 
+    
+    else 
+        
+        if isempty(PC(i).SrcBlock) 
+            
+            outports{end+1} = PortStr;
+            
+            for j = 1:length(PC(i).DstBlock)
+   
+                DstBlockHandle = PC(i).DstBlock(j);
+                DstBlockName = get_param(DstBlockHandle, 'Name');
+
+                DstPortField = PC(i).DstPort(j) + 1;
+                DstPC = get_param(DstBlockHandle, 'PortConnectivity');
+                DstPort = DstPC(DstPortField).Type;
+                
+                connections{end+1} = struct('from', sprintf("%s/%s", blk_name, Port), ...
+                    'to', sprintf("%s/%s", DstBlockName, DstPort));
+            
+            end 
+       
+        else
+
+            inports{end+1} = PortStr;
+
+        end
+    end
+end
+end 

matlab_simulink_mcp-0.1.2/src/matlab_simulink_mcp/data/helpers/snapshot_system.m

@@ -0,0 +1,18 @@
+function cwd = snapshot_system(system_path, main_system, open)
+
+load_system(main_system)
+
+if open
+    open_system(system_path);
+end
+
+dpi = '150'; 
+path = "-s" + system_path;
+quality = "-r" + dpi;
+file = "snapshot.png";
+
+print(path, "-dpng", quality, file);
+
+cwd = fullfile(pwd, 'snapshot.png');
+
+end

matlab_simulink_mcp-0.1.2/src/matlab_simulink_mcp/data/helpers/validate_code.m

@@ -0,0 +1,2 @@
+function issues = validate_script(file_name)
+issues = {checkcode(file_name).message};

matlab_simulink_mcp-0.1.2/src/matlab_simulink_mcp.egg-info/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: matlab-simulink-mcp
+Version: 0.1.2
+Summary: An MCP server for allowing LLMs to interact with MATLAB and Simulink
+Author: Rohail
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastmcp>=2.12.2
+Requires-Dist: platformdirs>=4.4.0
+Dynamic: license-file
+
+# MATLAB Simulink MCP Server
+
+This Model Context Protocol (MCP) 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, is built on top of the [FastMCP 2.0](https://gofastmcp.com/getting-started/welcome) library, and uses MATLAB Engine for Python API to communicate with MATLAB and Simulink.
+
+## 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
+
+1. Install using:
+
+    ```bash
+    uv pip install matlab-simulink-mcp
+    # or
+    pip install matlab-simulink-mcp
+    ```
+
+2. On the 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": "absolute-path-to/.venv/Scripts/python.exe", // absolute path to your venv/global environment executable
+            "args": ["-m", "matlab_simulink_mcp"]
+            }
+        }
+    }
+    ```
+
+    On macOS/Linux, use `absolute-path-to/.venv/bin/python` in `command`.
+
+    **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 Claude's 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. It launches a UI to send dummy requests directly to the server.
+
+To use it, import `mcp` from `matlab_simulink_mcp.server` into a script and run the script using `fastmcp dev script_name.py`

{matlab_simulink_mcp-0.1.0 → matlab_simulink_mcp-0.1.2}/src/matlab_simulink_mcp.egg-info/SOURCES.txt

@@ -1,4 +1,6 @@
+LICENSE
 README.md
+README_pypi.md
 pyproject.toml
 src/matlab_simulink_mcp/__init__.py
 src/matlab_simulink_mcp/__main__.py
@@ -16,6 +18,12 @@ src/matlab_simulink_mcp.egg-info/top_level.txt
 src/matlab_simulink_mcp/data/__init__.py
 src/matlab_simulink_mcp/data/blacklist.txt
 src/matlab_simulink_mcp/data/simlib_db.json
+src/matlab_simulink_mcp/data/helpers/describe_system.m
+src/matlab_simulink_mcp/data/helpers/format_system.m
+src/matlab_simulink_mcp/data/helpers/get_images.m
+src/matlab_simulink_mcp/data/helpers/get_ports_connections.m
+src/matlab_simulink_mcp/data/helpers/snapshot_system.m
+src/matlab_simulink_mcp/data/helpers/validate_code.m
 src/matlab_simulink_mcp/installer/__init__.py
 src/matlab_simulink_mcp/installer/installer.py
 src/matlab_simulink_mcp/installer/launcher.py

matlab_simulink_mcp-0.1.0/PKG-INFO

@@ -1,169 +0,0 @@
-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/pyproject.toml

@@ -1,33 +0,0 @@
-[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/src/matlab_simulink_mcp.egg-info/PKG-INFO

@@ -1,169 +0,0 @@
-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.