bimaiBuild on bimai
Build a connector
Connect a cloud API, a desktop app, a file format or an existing MCP server.
Not built yet
Planned for v0.1. This page describes the target experience; commands may not exist yet.
The recipe
Pick the type
Cloud API, desktop bridge, file, or an existing MCP server.
Scaffold
/bimai:new-connector creates the folder and the manifest from a template.
Define tools
Read tools first. Write tools always support a dry run and are safe to retry.
Declare capabilities
So existing packs can use your connector.
Implement and record test data
Against a real project, recorded so tests run without accounts.
Certify and register
/bimai:certify, then /bimai:register, read-only first. Add a documentation page.
The contract
- Tool names:
<connector>_<resource>_<verb>, e.g.revit_elements_query. - Every result carries an evidence ID and its source.
- Errors use a shared list:
auth_expired,forbidden,not_found,rate_limited,invalid_input,app_unavailable,upstream_unavailable,conflict. - Secrets live in the OS keychain and never appear in results or logs.
Desktop bridges (Revit, Civil 3D, OpenRoads, Bonsai)
- Every call runs in the app's safe context (for Revit,
ExternalEvent). - Every approved change is one undo step in the app.
- When the app isn't running, the connector says so clearly (
app_unavailable). - Declare the platforms: Revit, Civil 3D and OpenRoads bridges are Windows-only.