Which package do I need?
Three packages, two registries. Which you need depends on what you are building.
| Package | Registry | Language | What it is for |
|---|---|---|---|
nimblebrain-server-sdk |
PyPI | Python | The server. Tool annotations, change announcements, the ai.nimblebrain extensions, skills and the error contract, with database access, observability and notifications as extras. Docs |
@nimblebrain/synapse |
npm | TypeScript | An app’s interface. The part that runs in the browser: calling tools, staying in sync with the agent, theming. Docs |
@nimblebrain/sdk |
npm | TypeScript | The API client. A program that calls NimbleBrain’s API from outside. Not used to build a server. |
Serving the interface from the server needs no NimbleBrain package. It is the MCP Apps standard, which FastMCP 4 implements in fastmcp.apps.
By what you are building
Section titled “By what you are building”| You are building | Install |
|---|---|
| A connector: a server alone | nimblebrain-server-sdk |
| An app: a server plus its interface | nimblebrain-server-sdk in the server, which serves the interface with FastMCP’s AppConfig; @nimblebrain/synapse in the interface |
| A program that calls NimbleBrain | @nimblebrain/sdk |
| A server in another language | None. Implement the protocol from the “Wire (any SDK)” tabs, starting at MCP extensions |
How an app fits together
Section titled “How an app fits together”The interface is built with @nimblebrain/synapse to one self-contained HTML file. The server is a FastMCP 4 server with the Server SDK. It serves that file as a ui:// resource and binds tools to it, both with fastmcp.apps.AppConfig:
from fastmcp.apps import AppConfig, ResourceCSP
@mcp.resource("ui://tasks/main", app=AppConfig(prefers_border=True, csp=ResourceCSP()))def tasks_ui() -> str: return UI_HTML
@mcp.tool(app=AppConfig(resource_uri="ui://tasks/main", visibility=["model", "app"]))async def list_tasks() -> dict: ...| Version | |
|---|---|
nimblebrain-server-sdk |
0.7 or later |
| FastMCP | 4.0 or later |
| Python | 3.13 or later |
Synapse’s Serve a Synapse UI from a FastMCP server walks through it, and ChatGPT compatibility covers the keys only ChatGPT reads. NimbleBrain’s own additions for a view (placements, theming, the bridge) are under App Views.
The two packages do different jobs and do not overlap: the Server SDK is what the server shares with NimbleBrain’s host, and Synapse is what the interface uses to reach the server, on any host.
Related
Section titled “Related”- Build for NimbleBrain
- Compatibility and stability of the Server SDK