Skip to content

README.md

Latest commit

 

History

History
91 lines (69 loc) · 3.91 KB

README.md

File metadata and controls

91 lines (69 loc) · 3.91 KB
Raw

nimblebrain-synapse (Python)

The server half of the Synapse cross-host UI framework. Pairs with the @nimblebrain/synapse client (connectUI / window.SynapseUI).

pip install nimblebrain-synapse   # or: uv add nimblebrain-synapse

One SynapseUI declaration wires a self-contained HTML component into every host bridge a Synapse app renders in — ChatGPT (OpenAI Apps SDK), Claude (MCP Apps), and the NimbleBrain runtime — from a FastMCP server, replacing the per-app hand-rolled shim.

from mcp.server.fastmcp import FastMCP
from nimblebrain_synapse import SynapseUI

mcp = FastMCP("bassethound")

report_ui = SynapseUI(
    uri="ui://bassethound/report",
    template=load_template(),            # data-free HTML (carries the SDK + data markers)
    preferred_size=("100%", "auto"),
)
report_ui.register(mcp)                   # skybridge ui:// resource, SDK inlined

@mcp.tool(meta=report_ui.tool_meta(invoking="Picking up the scent…", invoked="Dossier ready"))
async def analyze_domain(domain: str) -> Dossier:
    ...

report_ui.bind(mcp, tool="analyze_domain", should_render=lambda d: "domain" in d)

register serves the host-facing ui:// resources (data-free), and tool_meta on the tool descriptor carries the binding pointers (openai/outputTemplate for ChatGPT, ui.resourceUri for SEP-1865 hosts). bind post-processes the CallToolResult for one tool: by default it mirrors the ChatGPT openai/outputTemplate pointer into the result _meta, so a standard host renders the registered component from structuredContent with no UI HTML in the result content. Pass embed_resource=True to also bake the legacy mcp-ui embedded copy (dossier in a <script>) into the content — off by default so that audience: ["user"] HTML can't leak into a client that won't render it. Plain MCP clients ignore the _meta and still read structuredContent.

Template contract

The template is data-free HTML that carries two markers:

  • <!--__SYNAPSE_SDK__--> — replaced with the inlined client SDK <script>.
  • <script type="application/json" id="synapse-ui-data">/*__SYNAPSE_DATA__*/</script> — the data slot; render_html(data) substitutes the escaped payload here (the served copy leaves the marker, so the client reads null and falls back to the host's push).

SynapseUI._safe_json escapes the payload for <script> embedding (the XSS defense) — framework-owned and on by default.

Interface debt

bind wraps FastMCP's CallToolRequest handler — a leak into FastMCP internals, quarantined in this one place. See the # TODO: upstream a real FastMCP result-transform hook note in server.py.

Client SDK asset

nimblebrain_synapse/_assets/synapse-ui.iife.js is the vendored client IIFE (window.SynapseUI), regenerated from the JS build (dist/synapse-ui.iife.global.js) and inlined at register time so a component is fully self-contained (CSP-safe, no CDN). CI fails on drift from the build. nimblebrain_synapse.__client_version__ records which @nimblebrain/synapse release the bundled IIFE was built from.

Versioning & compatibility

nimblebrain-synapse (PyPI) versions independently of @nimblebrain/synapse (npm). They change for different reasons at different cadences — the server descriptor is thin and stable; the JS client evolves with host adapters and theming — so they do not share a version number. The exact client build a given release bundles is recorded in nimblebrain_synapse.__client_version__ (and, per release, in the CHANGELOG); CI keeps it equal to the sibling package.json at HEAD.

What both halves share is the wire protocol — the ui:// resource MIMEs, the _meta dialects, and the data-element contract:

  • ext-apps 2026-01-26
  • MCP Apps (SEP-1865)
  • OpenAI Apps SDK

Releases publish on a nimblebrain-synapse-v* tag (distinct from the npm v* tags).