openstudio-mcp

使用说明（简明要点，便于开发者快速上手）：

• 项目定位与作用
  • 提供一个基于 MCP 的后端服务，用于向 LLM 客户端暴露 OpenStudio 资源、工具和提示模板，支持会话管理和多种传输方式，帮助实现对能源模型的自然语言驱动操作与推理流程。
• 主要功能点
  • 资源管理：对 OpenStudio 模型、气象数据、运行结果等资源的托管与查询。
  • 工具注册与执行：注册大量工具，LLM 可以逐步调用完成模型构建、修改、仿真与结果提取等任务。
  • 提示模板（Prompts）渲染：定义并渲染可自定义的对话/工作流提示，支持不同的交互模式。
  • JSON-RPC 通信：服务器端以 MCP 标准的 JSON-RPC 协议与客户端沟通，处理请求并返回结构化响应。
  • 会话与能力声明：管理会话、能力集声明，确保多客户端并发安全访问。
  • 多传输协议支持：标准输入输出（stdio）为主，此外可拓展为 SSE、WebSocket 等传输。
  • 运行状态与产出：通过 /runs 目录组织运行输出，便于追踪与复现实验。
• 安装与运行步骤（精简版）
  • 本地开发/测试
    1. 克隆仓库并进入项目根目录
    2. 使用 Docker 构建镜像，例如指定 dev 模式
    3. 启动容器并以 MCP 服务器模式运行
  • 在集成环境中使用时，建议通过 MCP 主机/客户端与服务器对接，按照仓库中的 Quick Start 配置进行对接。
• 服务器配置（适用于 MCP 客户端连接）
  • 以下为配置要素的说明，适用于需要在 MCP_HOST 配置中描述的 JSON 配置条目：
  • server name: openstudio-mcp，用于标识该 MCP 服务器实例
  • command: 启动该 MCP 服务器的可执行命令（示例为 openstudio-mcp）
  • args: 启动命令的附加参数列表，通常包含进入服务器的子命令及必要选项
  • 注：MCP 客户端在连接时至少需要知道启动命令与参数，以便正确启动并通过标准输入输出与服务器进行 JSON-RPC 交互。实际在你的环境中可通过环境变量（如 MCP_SERVER_CMD、MCP_SERVER_ARGS）覆盖配置。
  • 服务器配置示例要素（JSON 格式描述，实际使用时请以文本描述形式参考）：
    • server_name: "openstudio-mcp"
    • command: "openstudio-mcp"
    • args: ["openstudio-mcp"] 备注：这是最直接的启动方式，若使用 Docker，请在宿主机通过 MCP 的配置能力注入等价参数。
• 基本使用方法
  • 客户端（如 Claude Desktop、Cursor、Claude Code 等）通过 MCP_JSON-RPC 协议向服务器发送请求，服务器响应 JSON-RPC 结果。
  • 常见流程包括：创建/加载 OpenStudio 模型、查询模型信息、注册并执行工具、运行 EnergyPlus 仿真、提取结果、查看并渲染 Prompts/工作流。
  • 你可以通过工具列表进行能力探查，逐步执行并对比结果，逐步构建对话式工作流。
  • 参考仓库中的快速启动与集成测试用例，以便快速验证 MCP 服务器在容器化环境的行为。