roruizf/openstudio-mcp-server

本页由 AI 翻译，技术细节请以原文为准。查看原文

11 stars 2 forks 质量 69 趋势 18MIT

概览

A server that enables AI assistants like Claude to interact with building energy models. Load, inspect, and manipulate OpenStudio Model (OSM) files through a comprehensive set of tools accessible via natural language. This project is heavily based on the developed by (Lawrence Berkeley National Laboratory - Energy Technologies Area). The server architecture, tool structure, and implementation patterns have been replicated as closely as possible from their excellent work. The tools in this server are built using the library, which provides Python interfaces to OpenStudio's building modeling capabilities. This project was developed with the invaluable assistance of powered by .

README

以下为原文 README 节选，完整内容请查看原文。

OpenStudio MCP Server

A Model Context Protocol (MCP) server that enables AI assistants like Claude to interact with OpenStudio building energy models. Load, inspect, and manipulate OpenStudio Model (OSM) files through a comprehensive set of tools accessible via natural language.

Credits and Acknowledgments

This project is heavily based on the EnergyPlus MCP Server developed by LBNL-ETA (Lawrence Berkeley National Laboratory - Energy Technologies Area). The server architecture, tool structure, and implementation patterns have been replicated as closely as possible from their excellent work.

The tools in this server are built using the OpenStudio-Toolkit library, which provides Python interfaces to OpenStudio’s building modeling capabilities.

This project was developed with the invaluable assistance of Claude Code powered by Anthropic’s Claude Sonnet 4.5.

Features

Available Tools (20+)

📁 File & Model Management

load_osm_model - Load OpenStudio Model files with intelligent path resolution
save_osm_model - Save modified models
convert_to_idf - Export to EnergyPlus IDF format
copy_file - Copy files with fuzzy matching and smart discovery
get_model_summary - Get comprehensive model statistics
get_building_info - Get building object details

📊 Visualization & Analysis

apply_view_model - Generate interactive HTML visualization (geometry, HVAC, zones, materials)
apply_space_type_and_construction_set_wizard - Apply ASHRAE 90.1 building templates

🏗️ Building Geometry

list_spaces - List all spaces with properties
get_space_details - Get detailed information about a specific space
list_thermal_zones - List all thermal zones
get_thermal_zone_details - Get detailed zone information

🧱 Materials & Constructions

list_materials - List all materials with thermal properties

🌀 HVAC Systems

list_air_loops - List all air loop HVAC systems

💡 Internal Loads

list_people_loads - List occupancy loads
list_lighting_loads - List lighting power densities
list_electric_equipment - List equipment loads

📅 Schedules

list_schedule_rulesets - List all schedule rulesets

⚙️ Server Management

get_server_info - Get server configuration and status
get_current_model_status - Check currently loaded model

Key Capabilities

Intelligent File Discovery: Automatically finds files in multiple locations including Claude Desktop uploads
Fuzzy Matching: Finds files even with partial names or typos
Dual Environment Support: Works seamlessly in both Docker and Claude Desktop
Comprehensive API: Covers building geometry, HVAC, loads, materials, and schedules

Installation

Prerequisites

Docker Desktop (REQUIRED - recommended installation method)

在 GitHub 查看完整 README

安装

docker run --rm -i -v C:\\:/mnt/c -v C:\\PATH\\TO\\YOUR\\openstudio-mcp-server:/workspace -w /workspace/openstudio-mcp-server openstudio-mcp-dev uv run openstudio_mcp_server/server.py

新手？先看 mcpskill.org 教程 →

配置

{
  "mcpServers": {
    "openstudio": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-v", "C:\\:/mnt/c",
        "-v", "C:\\PATH\\TO\\YOUR\\openstudio-mcp-server:/workspace",
        "-w", "/workspace/openstudio-mcp-server",
        "openstudio-mcp-dev",
        "uv", "run", "openstudio_mcp_server/server.py"
      ]
    }
  }
}