Analysis Service SDK

ScriptBee is designed so that the Analysis Service is a replaceable component. Instead of being locked into a single in-memory implementation, any team can build and deploy their own Analysis Service — backed by a database, a graph engine like Neo4j, a remote computation cluster, or anything else — as long as it exposes the expected REST API.

The Analysis Service SDK packages everything needed to build such a service without writing HTTP boilerplate. You implement the business logic; the SDK handles routing, serialization, validation, and wiring.

Concept

┌────────────────┐   REST API    ┌──────────────────────────────┐
│   Gateway      │ ─────────────▶│   Your Analysis Service      │
│ (ScriptBee)    │               │                              │
└────────────────┘               │  SDK endpoints + validators  │
                                 │  ┌──────────────────────┐    │
                                 │  │  Your implementation  │    │
                                 │  │  of the use cases     │    │
                                 │  └──────────────────────┘    │
                                 └──────────────────────────────┘

The Gateway is the only client of the Analysis Service. It communicates exclusively through the public REST API. The SDK fully implements that API surface.

Use Cases

Every Analysis Service must support the following capabilities:

Capability	Description
Run Analysis	Execute a script against the currently loaded context
Get Context	Return all currently loaded context slices
Get Context Graph	Return the context as a graph (nodes + edges)
Load Context	Load files into the context using a loader plugin
Link Context	Link the loaded context using a linker plugin
Clear Context	Dispose of all loaded context
Generate Classes	Stream generated model class files for IDE support
Get Installed Plugins	List all plugins available in this service instance
Install Plugin	Install a plugin by identifier
Uninstall Plugin	Remove an installed plugin

Available SDK Implementations

Language	Package	Status
C#	DxWorks.ScriptBee.Analysis.Sdk on NuGet	✅ Available
TypeScript	—	🗓 Planned
Python	—	🗓 Planned

---

Note: All SDK implementations target the same REST API contract defined in docs/public/analysis_swagger.json. The Gateway does not know or care which language or backing store your service uses.