Skip to main content

OpenStudio AI harness with MCP runtime, host adapters, skills, and knowledge.

Project description

OpenStudio AI Harness

OpenStudio AI Harness packages a local MCP runtime, host adapters, skills, knowledge, and workflow-state tools for AI-assisted building-energy modeling.

Current Capabilities

  • OpenStudio MCP server for model lifecycle, simulation, results, SDK lookup, runtime storage, and MCP-backed blackboard workflow state.
  • Claude Code plugin export.
  • Codex plugin export.
  • Runtime learning schemas and candidate folders.
  • HVAC workflow skills and generated child skills.
  • Reviewed OpenStudio SDK knowledge packs.
  • Packaging north-star plan for stable pip install and marketplace agentic installation paths.

Development Setup

From this repository root:

python -m pip install -e ".[dev,standalone]"

Use .[dev,standalone] for full local harness development. The standalone extra installs the optional AUTOMA-AI and Streamlit dependencies used by agent.py, ui.py, and tests that exercise the local A2A agent path.

Install the runtime package after it is published:

python -m pip install openstudio-ai
openstudio-ai install-runtime
OPENSTUDIO_PATH=/path/to/openstudio openstudio-ai doctor
openstudio-ai-mcp --transport stdio

OpenStudio AI requires both the PyPI openstudio Python package, installed as a dependency of openstudio-ai, and the native OpenStudio application/CLI. Set OPENSTUDIO_PATH when the CLI is not on PATH.

The base package is the recommended install for Claude Code, Codex, and other marketplace-style host integrations. It intentionally does not install AUTOMA-AI or Streamlit. To run the standalone local AI app, install:

python -m pip install "openstudio-ai[standalone]"
python agent.py
streamlit run ui.py

Standalone mode requires user-provided LLM configuration, such as API keys or model endpoint settings, in the local environment.

Run focused tests:

python -m pytest -q \
  tests/test_mcp_openstudio_smoke.py \
  tests/test_openstudio_sdk_docs.py \
  tests/test_openstudio_learning_pipeline.py \
  tests/test_openstudio_codex_adapter.py \
  tests/test_openstudio_claude_code_adapter.py

Start the MCP server in stdio mode:

openstudio-ai-mcp --transport stdio

Export local development plugins:

python -m adapters.claude_code_adapter export-plugin \
  --output-dir /tmp/openstudio-ai-claude-plugin

python -m adapters.codex_adapter export-plugin \
  --output-dir /tmp/openstudio-ai-codex-plugin

Export marketplace-oriented plugins that expect an installed runtime command:

python -m adapters.claude_code_adapter export-plugin \
  --output-dir /tmp/openstudio-ai-claude-plugin \
  --runtime-mode marketplace

python -m adapters.codex_adapter export-plugin \
  --output-dir /tmp/openstudio-ai-codex-plugin \
  --runtime-mode marketplace

Key Docs

Runtime State

Local runtime state is intentionally ignored by Git:

  • .openstudio_mcp_workspace/
  • .openstudio_ai_blackboards/
  • logs/
  • outputs/

The MCP runtime uses local SQLite metadata and filesystem workspaces for large OSM, SQL, and log artifacts.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openstudio_ai-0.1.2.tar.gz (795.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openstudio_ai-0.1.2-py3-none-any.whl (852.3 kB view details)

Uploaded Python 3

File details

Details for the file openstudio_ai-0.1.2.tar.gz.

File metadata

  • Download URL: openstudio_ai-0.1.2.tar.gz
  • Upload date:
  • Size: 795.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for openstudio_ai-0.1.2.tar.gz
Algorithm Hash digest
SHA256 932bb73ada2afc172626b8648a4a815ffbbc5bd3f247edc55369b47f08a2191b
MD5 61693283a2160431abd65f4318d1a510
BLAKE2b-256 4f64e0bcab63ae139e39ce73569e3bd8b7b06cefb7e358f351409b666e25df6d

See more details on using hashes here.

File details

Details for the file openstudio_ai-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: openstudio_ai-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 852.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for openstudio_ai-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ad39a8ff7175e7be1339fc04943b52f5f17ca2d79b67e957f154720bda987987
MD5 f04cc6b5633a781e030c0492978b60cd
BLAKE2b-256 7081f596d21f4f9d14b0f2638ae7c8afc2e51d5f4e8ea601b9a0d073b3a422b2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page