openstudio
MCP server from roruizf/openstudio-mcp-server
claude mcp add --transport stdio roruizf-openstudio-mcp-server 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
How to use
The OpenStudio MCP Server provides a suite of tools to load, inspect, and manipulate OpenStudio Model (OSM) files via natural language. Built atop the OpenStudio-Toolkit, it exposes capabilities for loading and saving models, exporting to IDF, inspecting buildings, spaces, and HVAC elements, and generating interactive visualizations. When connected through Claude Desktop or another MCP client, you can invoke specific tools like load_osm_model, get_model_summary, apply_view_model, and list_spaces to accomplish modeling tasks without manual scripting. The server supports intelligent file discovery, fuzzy matching for file names, and dual-environment operation (Docker and Claude Desktop). To get started, ensure the server is running in Docker and that Claude Desktop is configured to point at the mapped workspace where your repository lives.
How to install
Prerequisites:
- Docker Desktop installed and running
- Access to your OpenStudio MCP Server repository
- Claude Desktop or another MCP client (optional, for integration)
Quick Start (Docker - recommended):
- Clone the repository
git clone https://github.com/roruizf/openstudio-mcp-server.git
cd openstudio-mcp-server
- Build the Docker image (from the repository root):
docker build -t openstudio-mcp-dev -f .devcontainer/Dockerfile .devcontainer
- Run the MCP server inside Docker (example command you can adapt):
# Ensure you replace the host paths with actual locations on your machine
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
- Configure Claude Desktop (if using Claude) to point to the server similarly to the example in the README, ensuring proper volume mounts and the working directory match your setup.
- Verify installation by asking Claude Desktop: "What OpenStudio tools are available?"
Additional notes
Tips and considerations:
- The outputs directory is created inside the repository's outputs/ (mapped to your host via the workspace volume).
- For Windows hosts, follow the two-volume-mount guidance carefully: one mount provides host C: drive access, the other mounts the server source code for the container to run.
- If you modify the server code, rebuild the Docker image to pick up changes.
- Ensure the OpenStudio SDK and Python bindings used by the container are compatible with your models.
- Use the Intelligent File Discovery and fuzzy matching features to locate OSM files across different folders and Claude Desktop uploads.
Related MCP Servers
mcp-vegalite
MCP server from isaacwasserman/mcp-vegalite-server
github-chat
A Model Context Protocol (MCP) for analyzing and querying GitHub repositories using the GitHub Chat API.
nautex
MCP server for guiding Coding Agents via end-to-end requirements to implementation plan pipeline
pagerduty
PagerDuty's official local MCP (Model Context Protocol) server which provides tools to interact with your PagerDuty account directly from your MCP-enabled client.
futu-stock
mcp server for futuniuniu stock
mcp -boilerplate
Boilerplate using one of the 'better' ways to build MCP Servers. Written using FastMCP