docs: reconcile tool count, EnergyPlus range, and stability claims#72
Merged
Merged
Conversation
Three different tool counts were live across the ecosystem (idfkit.com=25, README=32, mcp.idfkit.com=35) when the actual count is 37, and two different EnergyPlus upper bounds (25.2 vs 26.1) when versions.py supports through 26.1. Fix the README and docs to match the code. Changes: - README: "32 tools / seven categories" -> "37 tools / ten categories, plus 13 MCP resources". Fix per-category counts to match @tool decorators in src/idfkit_mcp/tools/: Read 7->6, Write 9->10, Sim 5->8, Docs 3->2, add Geometry/Schedules/Migration rows. - docs/index.md: hero chip "35 MCP tools" -> "37 MCP tools". Drop "production-ready" wording and add an explicit beta admonition so the positioning matches idfkit's beta status (no contradictions between sites). - docs/tools/index.md: "35 tools in nine categories, plus 12 MCP resources" -> "37 tools in ten categories, plus 13 MCP resources". Add missing rows for remove_objects, migrate_model, and the idfkit://migration/report resource. - docs/concepts/architecture.md: Mermaid diagram "EnergyPlus 8.9 - 25.2" -> "EnergyPlus 8.9 - 26.1"; weather station count "16,000+" -> "~17,300 unique" to match idfkit's actual claim. https://claude.ai/code/session_017WyEWRf3BQkxcVc5bz7hfj
Contributor
|
Docs preview for this PR is available at: Changed pages: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three different MCP tool counts were live across the ecosystem (
idfkit.com=25,README=32,mcp.idfkit.com=35) when the actual count is 37 (verified by grepping@tooldecorators acrosssrc/idfkit_mcp/tools/). Two different EnergyPlus upper bounds were also in play (25.2vs26.1) whenversions.pysupports through26.1. This PR brings README + docs in line with the code.Changes
README.md:32 tools / seven categories→37 tools / ten categories, plus 13 MCP resources. Per-category counts corrected to match decorator reality (Read 7→6, Write 9→10, Sim 5→8, Docs 3→2; added Geometry, Schedules, Migration rows).docs/index.md: hero chip35 MCP tools→37 MCP tools. Dropped "production-ready" wording and added an explicit Beta admonition. Per the audit decision, both idfkit and idfkit-mcp are positioned as beta — no contradictions between sites.docs/tools/index.md: header counts fixed; catalog table now includes the previously-missingremove_objects,migrate_model, andidfkit://migration/reportrows.docs/concepts/architecture.md: Mermaid diagramEnergyPlus 8.9 – 25.2→8.9 – 26.1. Weather station count16,000+→~17,300 unique(matches idfkit's actual WMO unique count).Companion PRs
idfkit/idfkit#161— fix__version__to read from package metadata; bumppyproject.tomlto0.12.2; correct stale weather-station counts in README & docs.idfkit/idfkit.com(separate PR, same branch) — sync MCP tool count, EP range, and weather-station hero stat with ground truth.Test plan
make docsrendersdocs/index.md,docs/tools/index.md, anddocs/concepts/architecture.mdwithout errors.mcp.idfkit.com/docs/tools/shows 37 rows across 10 categories.EnergyPlus 8.9 – 26.1and~17,300 unique stations.37 MCP tools.https://claude.ai/code/session_017WyEWRf3BQkxcVc5bz7hfj
Generated by Claude Code