matlab-simulink-mcp 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

matlab_simulink_mcp-0.1.1.dist-info/METADATA

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: matlab-simulink-mcp
+Version: 0.1.1
+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.dist-info → matlab_simulink_mcp-0.1.1.dist-info}/RECORD

@@ -12,8 +12,9 @@ matlab_simulink_mcp/installer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 matlab_simulink_mcp/installer/installer.py,sha256=0SHMTaqZjSvb9zKx4in67bS5xT4JcnsO2U2vYvmb968,5949
 matlab_simulink_mcp/installer/launcher.py,sha256=aGuxkXnLcb1OZ4P6rHvXFi8KZsDUZVQlo0rNvjdmFqA,1438
 matlab_simulink_mcp/installer/win_elevate.py,sha256=LyHHUh4vWmIlIXxrM9tOhQUvVeMxcVdXMzkC3vbGm3A,514
-matlab_simulink_mcp-0.1.0.dist-info/METADATA,sha256=gYmQ8SGHTA3mk-sg9loIb8DwK8kCg2yDojsMUtk8h6I,6604
-matlab_simulink_mcp-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-matlab_simulink_mcp-0.1.0.dist-info/entry_points.txt,sha256=0ba8PFlQcaWyAqKXRIVDfDvrifeD5LY60lV7i6ak9oE,74
-matlab_simulink_mcp-0.1.0.dist-info/top_level.txt,sha256=90gv-RNCWWS7E-JMiqwUf2TjB_B8Zb2B-crAeXaABqU,20
-matlab_simulink_mcp-0.1.0.dist-info/RECORD,,
+matlab_simulink_mcp-0.1.1.dist-info/licenses/LICENSE,sha256=qxK38PIeAkpnIu0mX7Re5nGKlHEx1Ez4p_4Yg4-3-Hw,1090
+matlab_simulink_mcp-0.1.1.dist-info/METADATA,sha256=fA8SHhzZyrCMsgm86TKMcHtMSezn14B9DP-IduVpaUc,4125
+matlab_simulink_mcp-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+matlab_simulink_mcp-0.1.1.dist-info/entry_points.txt,sha256=0ba8PFlQcaWyAqKXRIVDfDvrifeD5LY60lV7i6ak9oE,74
+matlab_simulink_mcp-0.1.1.dist-info/top_level.txt,sha256=90gv-RNCWWS7E-JMiqwUf2TjB_B8Zb2B-crAeXaABqU,20
+matlab_simulink_mcp-0.1.1.dist-info/RECORD,,

matlab_simulink_mcp-0.1.1.dist-info/licenses/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.0.dist-info/METADATA

@@ -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.