Matlabmcp

🚀 MATLAB MCP 集成

本项目是为 MATLAB 实现的 Model Context Protocol (MCP) 服务器。它借助 MATLAB 引擎 API for Python，让 MCP 客户端（如 LLM 代理或 Claude Desktop）能与共享的 MATLAB 会话进行交互。

🚀 快速开始

本项目允许 MCP 客户端通过 MATLAB 引擎 API for Python 与共享的 MATLAB 会话交互。你可以按照以下步骤进行操作：

1. 克隆此仓库：

   git clone https://github.com/jigarbhoye04/MatlabMCP.git
   cd MatlabMCP
   

2. 设置 Python 虚拟环境（推荐）：

   # 如果尚未安装，请先安装 uv：https://github.com/astral-sh/uv
   uv init
   uv venv
   source .venv/bin/activate  # 在 Windows 上使用：.venv\Scripts\activate
   

3. 安装依赖项：

   uv pip sync
   

4. 确保 MATLAB 已安装，并且 MATLAB 引擎 API for Python 配置完成。请参考 MATLAB 文档。
5. 启动 MATLAB 并共享其引擎：在 MATLAB 命令窗口运行以下命令：

   matlab.engine.shareEngine
   

   您可以通过在 MATLAB 中运行 matlab.engine.isEngineShared 来验证是否已共享（它应返回 true）。

✨ 主要特性

• 执行 MATLAB 代码：使用 runMatlabCode 工具运行任意 MATLAB 代码片段。
• 获取变量：使用 getVariable 工具获取 MATLAB 工作区中的变量值。
• 结构化通信：工具返回结果和错误作为结构化的 JSON，便于客户端进行编程处理。
• 非阻塞执行：使用 asyncio.to_thread 异步运行 MATLAB 引擎调用，避免阻塞服务器。
• 标准日志记录：使用 Python 的标准 logging 模块，输出到 stderr 以便在客户端日志中可见。
• 共享会话：连接到一个现有的共享 MATLAB 会话。

待办事项：

• 添加 setVariable 工具以将数据写入 MATLAB 工作区。
• 添加 runScript 工具以直接执行 .m 文件。
• 增加工作区管理工具（例如 clearWorkspace，getWorkspaceVariables）。
• 扩展 matlab_to_python 辅助函数，支持更多复杂数据类型（结构体、单元格数组、对象）。
• 添加对 Simulink 模型的交互支持。

📦 安装指南

环境要求

• Python 3.12 或更高版本
• MATLAB（推荐 R2023a 或更高版本 - 请检查 MATLAB 引擎 API for Python 的兼容性）并安装了 MATLAB 引擎 API for Python。
• numpy Python 包。

安装步骤

1. 克隆此仓库：

   git clone https://github.com/jigarbhoye04/MatlabMCP.git
   cd MatlabMCP
   

2. 设置 Python 虚拟环境（推荐）：

   # 如果尚未安装，请先安装 uv：https://github.com/astral-sh/uv
   uv init
   uv venv
   source .venv/bin/activate  # 在 Windows 上使用：.venv\Scripts\activate
   

3. 安装依赖项：

   uv pip sync
   

4. 确保 MATLAB 已安装，并且 MATLAB 引擎 API for Python 配置完成。请参考 MATLAB 文档。
5. 启动 MATLAB 并共享其引擎：在 MATLAB 命令窗口运行以下命令：

   matlab.engine.shareEngine
   

   您可以通过在 MATLAB 中运行 matlab.engine.isEngineShared 来验证是否已共享（它应返回 true）。

📚 详细文档

配置

将此服务器与 Claude Desktop 集成的说明：

1. 在您的项目中克隆此仓库。
2. 在 config.json 文件中填写必要的配置信息，例如 API 密钥和端点。
3. 启动服务器并连接到 Claude 平台。

开发

有关此服务器功能、使用和开发注意事项的详细文档，请参阅 此处。

🤝 贡献

欢迎贡献！如果您有任何建议或改进意见，随时提交问题或拉取请求。让我们一起让这个项目变得更好！