Docs/Developers

Neuron SDK

Use shared business context from your own application or AI assistant.

What it is

The SDK is a Node.js library for connecting your code to Neuron. Your application can retrieve the business concepts, relationships and process rules that a user has permitted it to read. You choose the interface and AI provider.

Instead of copying the same business explanation into every application, keep it in a versioned Neuron workspace and retrieve the relevant parts when needed. The SDK does not manage your AI conversation or automatically choose the right context for you.

Useful things to build

ApplicationWhat Neuron contributesWhat you still build
Purchasing assistantPublished process stages, policies and declared readsConversation, missing-input questions and any business-system integration
Quotation interfaceConfigured product/pricing capabilities and authorized filesCustomer experience and an actual qualified quotation integration
Operations dashboardDefined process data reads and shared meaningsDisplay, filters and refresh behavior
Planning assistantSeparately authorized computation jobs and result receiptsJob monitoring, complete result reading and user decisions

SDK or MCP?

Use the SDK when writing an application in Node.js. Use Neuron’s MCP endpoint directly when connecting a compatible external AI client. The SDK uses that same MCP interface; it is not a separate source of permissions.

Release status

MIT-licensed developer beta, available through GitHub source and release archives. No public npm package is available. Do not assume the working package name @neuron/sdk is available on npm.

The MIT license covers SDK code, not Neuron’s server, hosted service access or customer data. Node.js 22 or newer is supported; no browser bundle or Python SDK is supplied.

Start with one read

Follow the SDK quickstart to authorize a workspace and read its complete permitted published model and process rules. Process execution, model editing and computations have separate permissions. A defined process is not proof that a connector or executable tool is ready.