MutinyBIM reference
Generated from the code on every change, for people and for agents. For guides and the why behind the design, start at the docs index.
Writing scripts
- Example scripts: 4 whole scripts to copy
- Recipes: 31 worked tasks
- Script kit: 137 functions
- ctx: the script context: 15 functions
- units: 6 functions
- building: 27 functions
- routes: 12 functions
- equipment: 3 functions
- parts: 8 functions
- PartBuilder: 22 functions
- documents: 42 functions
- checks: 1 functions
- defineScript: 1 functions
- Edit commands: 204 commands
ctx.edittakes - Calcs: 28 calculations
ctx.calcruns - Pack reads: 12 reads
ctx.readruns - TypeScript declarations: the whole kit as one
script-kit.d.ts, for an agent or editor that type-checks scripts. The docs site builds it;kitDeclarations()in@permitzip/bim-scriptreturns it.
The platform
- Add-ons: 9 add-ons and what each contributes
- Tool server tools: 168 MCP tools in 12 families