Technical and integration guide
The supported machine interface, file contracts and system boundaries.
Source reviewed Engineering documentation
For questions about the guides themselves, read use these docs with AI.
For external software, start with the Workpapers MCP interface. For file-based handover, use formats and limits. For a technical assessment, read the architecture overview and data flow.
Choose the actual integration
| Need | Current route | Boundary |
|---|---|---|
| Read cases and obtain delivered workbooks | Workpapers MCP with a practice API key | The key's practice and granted scopes |
| Upload case evidence or start a build | MCP write scopes and the documented upload/build flow | Changes records; builds use the practice's allowance |
| Bring in a client list | Reviewed CSV/Excel import | User confirms additions and matches |
| Read and send a member's Outlook mail | The member's Microsoft connection | Their connected mailbox and the practice's reading settings |
| Review Xero GST coding | GST Audit Report CSV in BAS Review | No Xero ledger write-back |
| Convert a PDF locally | Sift's browser flow | No assumption of a public conversion API |
Do not use an internal database table or edge-function name as an undocumented public contract. The MCP tools expose a deliberate subset of the system and check their own credentials and scopes.
Developers maintaining BeforeMay
Local setup, secrets, database migrations, CI and deployment procedures are in the repository's maintainer documentation. They are separate from the public integration contract. The public architecture page explains the boundaries without publishing credentials or operational access instructions.
For the maintained source map, reviewers can ask support for an evidence pack appropriate to their assessment. Start with assessment evidence to specify which controls and deployed version need to be examined.