Browse the documentation

Packages

What you install, and what is bundled.

What you install

NetlyDB.SDK is the only published package. It targets net10.0 and carries the engine and every NetlyDB component an application uses:

  • the document engine, file collections, query pipeline, indexing, persistence and replication;
  • hosting, health checks and offline license verification;
  • the REST API, the MCP server and the Management UI, which run only when you register them.

The engine's types appear in the SDK's public API, but they are not published as a separate package, and neither are the API, MCP or Management UI components.

Third-party packages for optional modules

Each optional module needs third-party packages that NetlyDB.SDK does not pull in. If they are missing, the registration throws NetlyDBOptionalFeatureUnavailableException (NDB-LIFE-0064) naming them. The versions below are minimums.

ModuleEnabled byYour application references
REST APIAddNetlyDBAPI()Swashbuckle.AspNetCore 10.2.3, Microsoft.AspNetCore.OpenApi 10.0.10, Microsoft.OpenApi 2.7.5, Microsoft.AspNetCore.Authentication.JwtBearer 10.0.10, Microsoft.IdentityModel.Tokens 8.19.2
MCP serverAddNetlyDBMCP()ModelContextProtocol 1.2.0, ModelContextProtocol.AspNetCore 1.2.0, Microsoft.AspNetCore.OpenApi 10.0.10, Microsoft.OpenApi 2.7.5, Microsoft.AspNetCore.Authentication.JwtBearer 10.0.10, Microsoft.IdentityModel.Tokens 8.19.2
Management UIAddNetlyDBManagementUI()Everything the REST API and MCP server need, plus Imageflow.Net 0.13.2, Imageflow.AllPlatforms 0.13.2, OpenAI 2.10.0, System.ClientModel 1.10.0, System.Memory.Data 10.0.3, Microsoft.Extensions.AI.Abstractions 10.4.1, Microsoft.Extensions.Http.Polly 10.0.10, Polly.Extensions.Http 3.0.0
Azure Blob storage (read-only)UseStorageProvider<AzureBlobStorageProvider>()Azure.Storage.Blobs 12.21.1

Not published

These exist in the NetlyDB repository but no package delivers them:

  • Not yet published the embedding package for managed embedding generation (details);
  • Not yet published the command-line tool (details);
  • Not yet published Android-specific packages and a .NET MAUI version of the Management UI.

Signing

Packages are not code-signed. Their provenance records that explicitly.

An unhandled error has occurred. Reload X

Reconnecting

Restoring the connection to the server...

Still trying

Next attempt in seconds

Connection lost

We could not reach the server.