Skip to content

README.zh-cn.md

Latest commit

 

History

History
225 lines (165 loc) · 16.8 KB

README.zh-cn.md

File metadata and controls

225 lines (165 loc) · 16.8 KB
Raw

MATLAB MCP Server

English • Español • 日本語 • 한국어 • 简体中文

使用 MathWorks® 官方的 MATLAB MCP Server，通过 AI 应用运行 MATLAB®。MATLAB MCP Server 允许您的 AI 应用执行以下操作:

  • 启动和退出 MATLAB。
  • 编写和运行 MATLAB 代码。
  • 评估 MATLAB 代码的风格和正确性。

MATLAB Agentic Toolkit (GitHub) 和 Simulink Agentic Toolkit (GitHub) 提供的技能 (skills) 可协助您的智能体使用 MATLAB 和 Simulink，还可以为您安装此 MCP 服务器。

目录

设置

  1. 安装 MATLAB (MathWorks) R2021a 或更高版本，并将其添加到系统 PATH 环境变量中。

  2. 该服务器支持任何使用模型上下文协议的 AI 应用。要为 Claude Desktop 设置 MATLAB MCP Server，请跳至 Claude Desktop 的说明。要为其他应用设置服务器，请按照以下说明操作:

    • 对于 Windows 或 Linux，请下载最新版本。(或者，您也可以从源代码编译: 安装 Go 并使用 go install github.com/matlab/matlab-mcp-server/cmd/matlab-mcp-server@latest 来编译二进制文件)。

    • 对于 macOS，请先在终端中运行以下命令以下载最新版本:

      • 对于 Apple silicon 处理器，请运行: 
        curl -L -o ~/Downloads/matlab-mcp-server https://github.com/matlab/matlab-mcp-server/releases/latest/download/matlab-mcp-server-macos-arm64
      • 对于 Intel 处理器，请运行: 
        curl -L -o ~/Downloads/matlab-mcp-server https://github.com/matlab/matlab-mcp-server/releases/latest/download/matlab-mcp-server-macos-x64

      然后向下载的二进制文件授予可执行权限，以便您可以运行 MATLAB MCP Server:

      chmod +x ~/Downloads/matlab-mcp-server

  3. 将 MATLAB MCP Server 添加到您的 AI 应用中。您可以在 AI 应用的文档中找到有关添加 MCP 服务器的说明。有关使用 Claude Code®、Claude Desktop® 和 GitHub Copilot in Visual Studio® Code 的示例说明，请参阅下文。请注意，您可以通过指定可选参量来自定义服务器。

Claude Code

在终端中运行以下命令，请在其中插入您在设置过程中获取的服务器二进制文件的完整路径:

claude mcp add --transport stdio matlab -- /fullpath/to/matlab-mcp-server-binary

您可以通过指定可选参量来自定义服务器。请注意 Claude Code 选项与服务器参量之间需使用 -- 分隔符:

claude mcp add --transport stdio matlab -- /fullpath/to/matlab-mcp-server-binary --initial-working-folder=/home/username/myproject

有关在 Claude Code 中添加 MCP 服务器的详细信息，请参阅 Add a local stdio server (Claude Code)。稍后要删除服务器，请运行:

claude mcp remove matlab

Claude Desktop

您可以使用 MATLAB MCP Server 捆绑包在 Claude Desktop 中安装 MATLAB MCP Server。

  1. 在 Claude Desktop 中安装 Filesystem 扩展程序，以允许 Claude 在您的系统上读写文件。在 Claude Desktop 中，点击 Settings > Extensions > Browse extensions。搜索由 Anthropic 开发的 Filesystem 扩展程序，然后点击 Install。指定要允许 MCP 服务器访问的文件夹，然后将 Disabled 按钮切换为 Enable 以启用 Filesystem 扩展程序。

  2. 从 Latest Release 页面下载 MATLAB MCP Server 捆绑包 matlab-mcp-server.mcpb。

  3. 要将 MATLAB MCP Server 捆绑包安装为桌面扩展程序，请双击下载的 matlab-mcp-server.mcpb 文件，然后在 Claude Desktop 中点击 Install。(或者，在 Claude 中导航到 File 菜单 > Settings > Extensions > Advanced Settings > Install Extension，然后选择 matlab-mcp-server.mcpb 文件。点击 Install)。

要自定义 MATLAB MCP Server 的行为，请导航到 Settings > Extensions > Configure，您可以在此修改服务器的参量。

GitHub Copilot in Visual Studio Code

在您的 VS Code 工作区中，创建一个名为 .vscode/mcp.json 的文件。插入以下 JSON，请指定您在设置过程中获取的服务器二进制文件的完整路径，以及任何参量。然后保存文件。(请注意，在 Windows 平台上，您需要额外的斜杠作为转义符)。

{
    "servers": {
        "matlab": {
            "type": "stdio",
            "command": "C:\\fullpath\\to\\matlab-mcp-server-windows-x64.exe",
            "args": []
        }
    }
}

有关在 VS Code 中使用 MCP 服务器的更多信息，请参阅 Add and Manage MCP servers in VS Code (VS Code)。

Codex

在终端中运行以下命令，请在其中插入您在设置过程中获取的服务器二进制文件的完整路径:

codex mcp add matlab -- /fullpath/to/matlab-mcp-server-binary

您可以通过指定可选参量来自定义服务器。例如:

codex mcp add matlab -- /fullpath/to/matlab-mcp-server-binary --initial-working-folder=/home/username/myproject

Note

Windows 用户: Codex 不会转发环境变量 WINDIR，而运行 MATLAB 和 Simulink 需要此变量（请参阅 #32）。

要添加此变量，请打开位于 C:\Users\<username>\.codex\config.toml 的 Codex 配置文件，并将 env_vars = ["WINDIR"] 添加到 [mcp_servers.matlab] 部分:

[mcp_servers.matlab]
command = 'C:\fullpath\to\matlab-mcp-server-windows-x64.exe'
args = []
env_vars = ["WINDIR"]

参量

通过以下方式之一指定参量来自定义服务器的行为:

  • 在 AI 应用的配置设置(通常为 .json 文件)中植入参量。
  • 启动服务器时，以命令行接口 (CLI) 标志的形式输入参量。
  • 使用环境变量，可在 CLI 或应用的配置设置中进行指定。要从 CLI 标志派生环境变量名称，请添加前缀 MW_MCP_SERVER_，转换为大写，并将连字符 (-) 替换为下划线 (_)。例如，参量 --matlab-root 对应的环境变量为 MW_MCP_SERVER_MATLAB_ROOT。如果同时使用两者，CLI 标志将优先于环境变量。
参量 说明 示例
help 显示所有参量的帮助信息。 --help
version 显示 MATLAB MCP Server 的版本。 --version
matlab-root 指定要启动的 MATLAB 的完整路径。路径中不要包含 /bin。默认情况下，服务器会尝试在系统的 PATH 环境变量中查找第一个 MATLAB。 Windows: --matlab-root=C:\Program Files\MATLAB\R2026a

Linux/macOS: --matlab-root=/home/usr/MATLAB/R2026a

作为环境变量:
MW_MCP_SERVER_MATLAB_ROOT=/home/usr/MATLAB/R2026a
initialize-matlab-on-startup 要在启动服务器后立即初始化 MATLAB，请将此参量设置为 true。默认情况下，MATLAB 仅在调用第一个工具时启动。 --initialize-matlab-on-startup=true
initial-working-folder 指定 MATLAB 启动时指向的工作文件夹。如果未指定值，MATLAB 会启动在 AI 应用的第一个 Root (MCP) 路径处。如果您尚未定义 root，MATLAB 会启动在以下位置:
  • Linux: /home/username
  • Windows: C:\Users\username\Documents
  • Mac: /Users/username/Documents
 Windows: --initial-working-folder=C:\\Users\\username\\MyProject

Linux/macOS: --initial-working-folder=/Users/username/MyProject
matlab-display-mode 指定是否显示 MATLAB 桌面。使用 desktop 模式(默认)将显示 MATLAB 桌面。使用 nodesktop 模式仅从 AI 应用使用 MATLAB，而不显示 MATLAB 桌面。请注意，在 nodesktop 模式下，需要图形界面的命令(例如 edit、open、open_system、uifigure 和 appdesigner)仍将在桌面上打开 MATLAB 窗口。 --matlab-display-mode=nodesktop
matlab-session-mode 指定 MCP 服务器是启动新的 MATLAB 还是连接到现有的 MATLAB 会话 (支持 MATLAB R2023a 及更高版本)。默认为 auto 模式。

new 模式: MCP 服务器启动新的 MATLAB 会话。

auto 模式 (默认): 服务器尝试连接到现有 MATLAB 会话，您必须已按照 existing 模式的说明配置该会话。如果服务器找不到现有 MATLAB 会话，则启动新会话。

existing 模式: 服务器尝试连接到现有 MATLAB 会话。请勿将此模式与参量 matlab-root、initial-working-folder 或 matlab-display-mode 一起使用。您必须提前配置好 MATLAB 会话才能使用此模式，步骤如下:

  1. 如果您首次使用 existing 模式，请运行 ./matlab-mcp-server --setup-matlab。

    此命令会在 MATLAB 中安装一个名为 MATLAB MCP Server Toolbox 的附加功能。您可以使用此表中的其他参量来自定义命令。例如，要指定使用哪个 MATLAB 来安装工具箱，可以使用 ./matlab-mcp-server --setup-matlab --matlab-root=/home/usr/MATLAB/R2026a。

    对于 Claude Desktop，在运行 ./matlab-mcp-server --setup-matlab 之前，您必须按照设置中的说明下载 MATLAB MCP Server 二进制文件。

  2. 在正在运行的 MATLAB 会话的命令行窗口中，运行 shareMATLABSession()。当您使用 --matlab-session-mode=existing 或 --matlab-session-mode=auto 启动服务器时，MCP 服务器将连接到此 MATLAB 会话。如果您正在运行多个 MATLAB 会话，服务器将连接到您最近运行 shareMATLABSession() 命令的 MATLAB 会话。

    作为手动运行 shareMATLABSession() 的替代方法，您可以将此命令添加到您的 MATLAB Startup 脚本 (MathWorks) 中。
 --matlab-session-mode=existing
extension-file 要使用自定义 MCP 工具，请提供定义工具的 JSON 文件的路径。您还可以使用多个扩展文件。有关使用自定义工具的详细信息，请参阅在 MATLAB MCP Server 中使用自定义工具。

Windows: --extension-file=C:\\Users\\name\\my-tools.json

Linux/macOS: --extension-file=/path/to/my-tools.json

使用多个扩展文件:

Windows:--extension-file=C:\\path\\to\\tools-1.json --extension-file=C:\\path\\to\\tools-2.json

Linux/macOS:--extension-file=/path/to/tools1.json --extension-file=/path/to/tools2.json

使用环境变量:

Windows: MW_MCP_SERVER_EXTENSION_FILE=C:\Users\name\tools1.json;C:\Users\name\tools2.json

Linux/macOS: MW_MCP_SERVER_EXTENSION_FILE=/path/to/tools1.json:/path/to/tools2.json
log-folder 指定 MCP 服务器存储日志文件的文件夹。如果未指定，服务器将使用操作系统的默认临时文件夹。 Windows: --log-folder=C:\\Users\\name\\AppData\\Local\\Temp

Linux/macOS: --log-folder=/tmp/my-logs
log-level MCP 服务器的日志级别。有效值按详细程度递减依次为 debug、info、warn 和 error。默认为 info。 --log-level=debug
disable-telemetry 要禁用匿名数据收集，请将此参量设置为 true。有关详细信息，请参阅数据收集。 --disable-telemetry=true

工具

  1. detect_matlab_toolboxes

    • 返回有关已安装的 MATLAB 和工具箱的信息，包括版本号。

  2. check_matlab_code

    • 对 MATLAB 脚本执行静态代码分析。返回有关编码风格、潜在错误、已弃用函数、性能问题和最佳实践违规的警告。这是一个非破坏性的只读操作，可在不执行脚本的情况下识别代码质量问题。
    • 输入:
      • script_path (字符串): 要分析的 MATLAB 脚本文件的绝对路径。必须是有效的 .m 文件。在分析过程中不会修改该文件。示例: C:\Users\username\matlab\myFunction.m 或 /home/user/scripts/analysis.m。

  3. evaluate_matlab_code

    • 计算 MATLAB 代码字符串并返回输出。
    • 输入:
      • code (字符串): 要计算的 MATLAB 代码。
      • project_path (字符串): 工程目录的绝对路径。MATLAB 将此目录设置为当前工作文件夹。示例: C:\Users\username\matlab-project 或 /home/user/research。

  4. run_matlab_file

    • 执行 MATLAB 脚本并返回输出。该脚本必须是有效的 .m file。
    • 输入:
      • script_path (字符串): 要执行的 MATLAB 脚本文件的绝对路径。必须是有效的 .m 文件。示例: C:\Users\username\projects\analysis.m 或 /home/user/matlab/simulation.m。

  5. run_matlab_test_file

    • 执行 MATLAB 测试脚本并返回全面的测试结果。专为遵循 MATLAB 测试框架约定的 MATLAB 单元测试文件设计。
    • 输入:
      • script_path (字符串): MATLAB 测试脚本文件的绝对路径。必须是包含 MATLAB 单元测试的有效 .m 文件。示例: C:\Users\username\tests\testMyFunction.m 或 /home/user/matlab/tests/test_analysis.m。

资源

MCP 服务器提供了 Resources (MCP)，以帮助您的 AI 应用编写 MATLAB 代码。要查看使用此资源的说明，请参阅 AI 应用中有关如何使用资源的文档。

  1. matlab_coding_guidelines

    • 提供全面的 MATLAB 编码标准，以提高代码的可读性、可维护性和协作性。这些规范涵盖命名约定、格式、注释、性能优化和错误处理。
    • URI: guidelines://coding
    • MIME Type: text/markdown
    • 来源: MATLAB Coding Standards (GitHub)

  2. plain_text_live_code_guidelines

    • 提供使用纯文本 Live Code .m 文件格式生成实时脚本的规则和规范，适用于版本控制和 AI 辅助开发。请注意，要运行纯文本实时脚本，您需要 MATLAB R2025a 或更高版本。有关详细信息，请参阅 Live Code File Format (MathWorks)。
    • URI: guidelines://plain-text-live-code
    • MIME Type: text/markdown
    • 来源: Plain Text Live Code Generation (GitHub)

数据收集

MATLAB MCP Server 可能会收集有关您使用服务器的完全匿名信息，并将其发送给 MathWorks。此数据收集有助于 MathWorks 改进产品，默认处于开启状态。要退出数据收集，请将参量 --disable-telemetry 设置为 true。

安全注意事项

使用 MATLAB MCP Server 时，在您运行任何工具调用之前，应先对其进行全面地审查和验证。对于重要操作，请始终保证有人参与其中，并且只有在您确信调用将完全按照您的预期执行时才继续操作。有关详细信息，请参阅 User Interaction Model (MCP) 和 Security Considerations (MCP)。

许可和使用

您可在此 GitHub 仓库的 LICENSE.md 文件中查看许可证。

MCP 服务器仅可在遵守 MathWorks 软件许可协议的前提下与 MATLAB 一起使用，且不得由多个用户共享使用。如需支持共享式或集中式服务器使用，请联系 MathWorks。

联系支持

MathWorks 鼓励您使用此仓库并提供反馈。要请求技术支持或提交增强请求，请创建 GitHub issue 或联系 MathWorks Technical Support。

Copyright 2025-2026 The MathWorks, Inc.