idfkit-mcp
   
一 主控程序 让AI助手直接使用的服务器 能源加 构建能源模型。将其连接到Claude、ChatGPT、Cursor、Codex或任何兼容MCP的客户端,并使用自然语言:
- 从头开始构建模型 --描述建筑,让代理创建分区、曲面、构造、明细表和HVAC系统
- 编辑现有模型 --加载IDF或epJSON文件,重命名对象,交换材质,调整设定点,并在执行过程中进行验证
- 运行模拟 --选择一个天气文件,启动EnergyPlus,在不离开对话的情况下查询或导出结果
- 探索模式 --问什么字段a
ZoneHVAC:IdealLoadsAirSystem接受,哪些值是有效的,并获取官方EnergyPlus文档的链接 - 搜索文档 --对EnergyPlus I/O参考、工程参考和托管在上的其他文档集进行全文搜索 docs.idfkit.com
文档 | ****
工具
服务器暴露 32工具 分为七类:
| 类别 | 工具 | 它们的作用 |
|---|---|---|
| 模式 | 4 | 探索对象类型、字段、约束和有效引用 |
| 模型读取 | 7 | 加载IDF/epJSON/OSM文件,检查对象,搜索和跟踪引用 |
| 模型编写 | 9 | 创建模型、添加/更新/删除/重命名/复制对象、保存和管理会话 |
| 验证 | 2 | 模式验证和悬空引用检测 |
| 模拟 | 5 | 运行EnergyPlus,汇总结果,查询输出变量,导出时间序列 |
| 天气 | 2 | 搜索全球气象站并下载EPW/DDY文件 |
| 文档 | 3 | 查找、搜索并阅读EnergyPlus文档 docs.idfkit.com |
所有工具都返回结构化的Pydantic模型。模式、验证和搜索结果包括直接 doc_url 链接到相关的EnergyPlus文档。
会话状态(加载的模型、模拟结果、天气文件)会自动持久化到磁盘上,因此在两个回合之间重新启动服务器的客户端(例如Codex)可以从停止的地方继续。
安装
pip install idfkit-mcp或与 紫外线:
uv add idfkit-mcp用法
以stdio MCP服务器运行(默认):
idfkit-mcp以流式HTTP MCP服务器运行:
idfkit-mcp --transport streamable-http --host 127.0.0.1 --port 8000快速MCP设置
添加 idfkit-mcp 您的MCP客户。Claude Desktop示例(~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"idfkit": {
"command": "uvx",
"args": ["--from", "idfkit-mcp", "idfkit-mcp"]
}
}
}看 MCP客户端设置 适用于所有支持的客户端(Claude Desktop、Cursor、VS Code、Claude Code、Windsurf、ChatGPT、Codex、JetBrains、Cline、Continue和Zed)。
发展
设置
# Clone the repository
git clone https://github.com/idfkit/idfkit-mcp.git
cd idfkit-mcp
# Install dependencies and pre-commit hooks
make install命令
make install # Install dependencies and pre-commit hooks
make check # Run linting, formatting, and type checks
make test # Run tests with coverage
make docs # Serve documentation locally
make docs-test # Test documentation build
make docker-build # Build base Docker image (no EnergyPlus)
make docker-build-sim ENERGYPLUS_TARBALL_URL=
# Build simulation image
make docker-build-sim DOCKER_PLATFORM=linux/amd64 ENERGYPLUS_TARBALL_URL=
# Apple Silicon + x86 tarball
make docker-run # Run Docker container释放
- 调整版本:
uv version --bump - 承诺并推动
- 创建一个 新版本 在GitHub上使用与版本匹配的标签(例如。,
1.0.0)
GitHub Action将自动发布到PyPI。
贡献
欢迎投稿!请参阅 贡献.md 作为指导方针。
