Compatibility and releases
This documentation covers Simfinity.js 3.0.1. The version menu links to the package and release history.
Requirements
| Component | Requirement |
|---|---|
| Library runtime | Node.js 18.18.0 or newer; use a maintained release for a new application |
| GraphQL peer | ^16.11.0 |
| Mongoose peer | ^8.16.2 |
| Mutations | MongoDB replica set or sharded cluster with transaction support |
| Downloadable starter | Node.js 22 or newer, npm and a transaction-capable MongoDB deployment |
| MCP tool generation | Available through named exports; the SDK is needed for MCP transports |
| Documentation development | Node.js 22 or newer |
Before upgrading
Check the release history and the npm package. Read changes between your installed version and the version you intend to use.
Exercise the operations your application relies on: generated names and input shapes, relationships, permissions, scopes, custom mutations, state actions and MCP allowlists. Keep GraphQL and Mongoose within the package's supported peer ranges.
The site currently documents one version. Historical examples in the repository README are not a separate, versioned documentation archive.
Get help with an integration
Start with troubleshooting. If an issue remains, open a GitHub issue with the installed versions, minimal schema and operation, expected result, and actual error. Remove credentials and private data from the reproduction.