Skip to content

Clarify LSP scope and Python-specific nature in README #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samuelduchesne merged 1 commit into from
May 27, 2026
Merged

Clarify LSP scope and Python-specific nature in README #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,14 @@ Claude Code, Cursor, Copilot, Gemini, Codex, and any MCP-capable client.
| **Workflow skills** | Task playbooks that orchestrate the MCP tools: `simulate`, `validate`, `new-model`, `load-model`, `energy-audit`, `weather`, `upgrade-version`, `idf-conventions`, `docs`. |
| **Agents** | Focused sub-agents: `energy-modeler`, `envelope-analyst`, `hvac-designer`. |
| **Commands & hooks** | `/quick-sim` slash command; context hooks that nudge agents toward the structured MCP tools when they touch `.idf` / `.epJSON` / `.epw` / `.ddy` files. |
| **LSP** | EnergyPlus language support via `.lsp.json`. |
| **LSP** | Python LSP for idfkit-based code (`idfkit-lsp`) via `.lsp.json`. |

> **Note on the LSP.** `idfkit-lsp` is a language server for *Python code that
> imports idfkit* — it does **not** provide an IDF/epJSON language server. Because
> it registers `.py` → `python`, the host attaches it to **every** Python file in
> the project, where it coexists with (and may compete with) your primary Python
> LSP such as Pylance, pyright, or ruff-lsp. If your editor supports scoping a
> server by workspace or activation pattern, narrow it to idfkit projects.

## Two contexts, two surfaces

Expand Down
Loading