Openstudio MCP

openstudio mcp

](https://lobehub.com/mcp/natlabrockies-openstudio-mcp)

模型上下文协议（MCP） 服务器 开放工作室 建筑能源模拟。使LLM和MCP主机（Claude Desktop、Cursor、Claude Code等）能够创建、查询和修改OpenStudio模型，运行EnergyPlus模拟，并检查结果——所有这些都是通过自然语言完成的。

23项技能•142个工具•6个提示•4个资源•480+个集成测试

______________________________________________________________________

它能做什么？

让你的AI助手做以下事情：

• *“建造一座配备VAV再热系统的10区办公楼，并进行年度模拟”*
• *“什么是EUI？给我看看未满足的供暖时间。”*
• *“将暖通空调从VAV切换到VRF热泵，并比较能源使用情况”*
• *“添加R-30屋顶隔热材料，看看它如何影响冷却负荷”*
• *“根据平面图建造两个相邻的区域，与共享墙相匹配，增加40%的南部玻璃”*
• *“编写一个自定义度量值，将所有灯光设置为8 W/m2，测试、应用并比较EUI”*
• *“从我的本地措施目录中应用AEDG小型办公室措施”*

服务器处理MCP工具调用背后的所有OpenStudio/EnergyPlus复杂性。

______________________________________________________________________

快速开始

先决条件

• Docker 桌面版 已安装并正在运行(下载)
• MCP主机 --可以连接到MCP工具服务器的AI应用程序。 克劳德桌面版 是推荐的起点。

步骤1：克隆和构建

git clone https://github.com/NatLabRockies/openstudio-mcp.git
cd openstudio-mcp
docker build -t openstudio-mcp:dev -f docker/Dockerfile .

步骤2：配置Claude桌面

打开您的Claude Desktop配置文件：

• macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
• 窗户： %APPDATA%\Claude\claude_desktop_config.json

添加（或合并到） mcpServers 块：

{
  "mcpServers": {
    "openstudio-mcp": {
      "command": "docker",
      "args": [
        "run", "--rm", "-i",
        "-v", "./tests/assets:/inputs",
        "-v", "./runs:/runs",
        "-v", "./.claude/skills:/skills:ro",
        "-e", "OPENSTUDIO_MCP_MODE=prod",
        "openstudio-mcp:dev", "openstudio-mcp"
      ]
    }
  }
}

• ./tests/assets:/inputs --安装附带的测试模型，以便您可以立即进行实验。替换为您自己的文件夹（例如。 ~/my-models:/inputs)当准备好。
• ./runs:/runs --模拟输出写在这里
• ./.claude/skills:/skills:ro --通过以下方式提供工作流程指南 list_skills() / get_skill() 工具
• 重新启动克劳德桌面 保存配置文件后

步骤3：验证连接

打开克劳德桌面，寻找 锤图标 聊天输入区域中的（MCP工具指示器）。单击它以查看列出的openstudio mcp工具。如果图标没有出现，请检查Docker是否正在运行，配置JSON是否有效。

第四步：开始聊天

按复杂性顺序尝试以下提示：

简单： “创建一个示例模型并告诉我”

介质： “使用ASHRAE System 3创建一个基线办公室，并向我展示暖通空调组件”

高级： “在/inputs/MyBuilding.osm加载我的模型，应用90.1-2019典型建筑模板，并运行模拟”

AI读取您的提示，从142个可用工具中选择正确的工具，按顺序调用它们，并总结结果——不需要脚本。

使用自己的文件

将文件放置在 /inputs 安装 （映射到的主机文件夹 /inputs 在上面的配置中），而不是通过聊天界面上传它们。这确保了MCP工具可以直接访问它们。

# Example: analyzing an EnergyPlus error file
# 1. Copy to your inputs folder
cp eplusout.err ./tests/assets/

# 2. Reference by MCP path in your prompt
"Analyze the warnings in /inputs/eplusout.err and create a measure to fix them"

为什么不上传？ Claude Desktop中的文件上传会激活一个无法与MCP工具通信的分析沙盒。AI可以编写脚本来处理任务，而不是使用142个可用的专用MCP工具。将文件放入 /inputs 保持MCP工作流程中的所有内容。

对于模拟输出（结果、SQL、HTML报告），这些已经在 /runs 并且可自动访问所有MCP工具。

其他MCP主机

客户端兼容性

______________________________________________________________________

克劳德编程技能

使用openstudio mcp时 克劳德代码，12项捆绑技能提供工作流自动化和领域知识：

工作流/任务技能通过以下方式调用 /skill-name知识技能在相关时会自动加载。

适用于所有MCP客户端的工作流程指南

同样的工作流程指南也可用作MCP工具，因此任何MCP客户端（Claude Desktop、Cursor等）都可以发现它们：

• list_skills() --查看带有描述的可用工作流
• get_skill(name) --获取特定工作流的分步说明

运行容器时挂载技能目录： -v ./.claude/skills:/skills:ro

______________________________________________________________________

技能和工具（共142个）

技能发现（2个工具）

服务器信息（2个工具）

模型创建（5个工具）

创建建筑能源模型的主要工具。 create_new_building 是大多数工作流的推荐起点。

模型管理（4个工具）

建筑（2个工具）

通过以下方式列出建筑故事 list_model_objects("BuildingStory").

空格（6个工具）

几何（9个工具）

构造（5个工具）

通过以下方式列出建筑 list_model_objects("Construction")，施工设置通过 list_model_objects("DefaultConstructionSet").

时间表（2个工具）

通过以下方式列出时间表 list_model_objects("ScheduleRuleset").

暖通空调（7个工具）

负载（6个工具）

通过以下方式加载列表 list_model_objects("People"), list_model_objects("Lights")等等。使用 get_object_fields 有关定义的详细信息。

空间类型（1个工具）

通过以下方式列出空间类型 list_model_objects("SpaceType").

模拟（8个工具）

结果（12个工具）

模拟输出（2个工具）

暖通空调系统（8个工具）

组件属性（10个工具）

通过以下方式列出暖通空调部件 list_model_objects("BoilerHotWater")循环细节工具等。

循环操作（9个工具）

对象管理（5个工具）

天气与模拟配置（7个工具）

措施（2个工具）

测量创作（4个工具）

使用AI生成的代码创建自定义OpenStudio度量，对其进行测试，并将其应用于模型。看 示例1, 示例2，以及 示例19 （完整的E2E改装）。

ComStock度量（1个工具）

API参考（2个工具）

工具路由器（1个工具）

常用措施（20种工具）

约79捆 openstudio常用措施gem 测量（报告、恒温器、信封、可再生能源、可视化、模型清理）。已预装在Docker镜像中。20个精选措施，21个专用包装工具。

______________________________________________________________________

ASHRAE基准系统

通过以下方式支持所有10个ASHRAE 90.1附录G基线系统 add_baseline_system:

加上3个现代模板： DOAS, 虚拟路由转发, 光辉.

______________________________________________________________________

支持的暖通空调组件类型

构件属性工具可以查询和修改这15种HVAC构件类型：

______________________________________________________________________

例子

19个具有完整工具调用序列的工作示例--单击展开：

______________________________________________________________________

测试

有关完整的测试指南——框架详细信息、带注释的示例、CI分片以及如何编写新测试——请参阅 docs/testing/ （或 docs/testing/testing.md 对于贡献者指南）。

快速开始

# Unit tests (no Docker)
pytest tests/test_skill_registration.py -v

# Integration tests (Docker)
docker build -t openstudio-mcp:dev -f docker/Dockerfile .

docker run --rm -v "$PWD:/repo" -v "$PWD/runs:/runs" \
  -e RUN_OPENSTUDIO_INTEGRATION=1 -e MCP_SERVER_CMD=openstudio-mcp \
  openstudio-mcp:dev bash -lc 'cd /repo && pytest -vv -s tests/'

______________________________________________________________________

开发模式与验证模式

# Prod mode (recommended for MCP hosts)
docker run --rm -i -e OPENSTUDIO_MCP_MODE=prod openstudio-mcp:dev openstudio-mcp

在 生产模式，stdout专门为MCP JSON-RPC消息保留。日志将转到stderr。

______________________________________________________________________

建筑

• 运输： stdio（由主机生成的容器）
• 协议： MCP（标准输入/标准输出上的JSON-RPC）
• 型号状态： 单内存模型 model_manager
• 跑： 储存在 /runs//
• 技能模式： 每一项技能 mcp_server/skills// 随着 tools.py （MCP注册）+ operations.py （商业逻辑）

完整的系统图、安全分析和加固建议： docs/architecture.md

______________________________________________________________________

贡献

添加新的MCP技能

1. 创建 mcp_server/skills//__init__.py, operations.py, tools.py
2. operations.py --纯业务逻辑，返回 {"ok": True/False, ...} 词典
3. tools.py --出口 register(mcp)，定义MCP工具模式
4. 在中添加测试 tests/test_.py
5. 在中添加CI步骤 .github/workflows/ci.yml
6. 技能通过自动注册 skills/__init__.py 发现
7. 更新 EXPECTED_TOOLS 在 tests/test_skill_registration.py
8. 更新中的工具计数 README.md 和 CLAUDE.md

添加新的Claude Code技能（工作流程指南）

1. 创建 .claude/skills//SKILL.md 使用YAML frontmatter：

   ---
   name: my-skill
   description: Short description for discovery
   ---

1. 在markdown正文中添加引用MCP工具名称的工作流说明
2. 对于用户调用技能，请添加 user-invocable: true （或省略--默认）
3. 有关背景知识，请添加 user-invocable: false
4. 对于即发即弃工作流，添加 context: fork
5. 在中添加集成测试 tests/test_skill_.py 执行工具顺序
6. 在中向CI分片添加测试 .github/workflows/ci.yml
7. 在中添加示例文档 docs/examples/_.md
8. 更新README示例部分和Claude代码技能表
9. 技能自动出现在 list_skills() / get_skill() 通过 /skills 安装

添加新的暖通空调组件类型

1. 添加 _get__props(obj) 和 _set__props(obj, properties) 在 components.py
2. 添加条目到 COMPONENT_TYPES 字典
3. 添加测试 tests/test_component_properties.py
4. 没有动态调度-每个OpenStudio API调用都必须是显式的和可编译的

______________________________________________________________________

许可证

看 许可证.