Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-staging.skybridge.tech/llms.txt

Use this file to discover all available pages before exploring further.

The Starter is what npm create skybridge scaffolds. It’s a short, interactive onboarding deck featuring the Skybridge mascot and a swappable hat. The deck walks new users through Skybridge’s core primitives: reading tool output, sharing view state with the model, and triggering tools from the view. Skybridge Starter

View source on GitHub

Browse the full template code.

Create your own

Scaffold the Starter locally with npm create skybridge.

​
What it demonstrates

The Starter registers two tools on the server and a single view that walks through four steps:
  • start: opens the onboarding view, with an optional name input the view reads back to greet the user.
  • get-fortune-cookie: a plain tool the view calls on demand to fetch a random prediction.
Each step of the deck highlights one Skybridge API:
  1. Reading tool output: the view hydrates with the name passed to start.
  2. Sharing view state: clicking “Change my hat” updates persisted view state and surfaces the current hat to the model via data-llm.
  3. Calling tools: the view invokes get-fortune-cookie from a button and renders the result.
  4. Examples & docs: outro linking to further reading.

​
Skybridge APIs used

  • useToolInfo: read the input and output of the tool that opened the view.
  • useViewState: persist UI state on the host and expose it to the model.
  • useCallTool: invoke a server tool from within the view.
  • useLayout: read host theme, display mode, and locale.
  • data-llm: describe what the user sees so the model can collaborate.