Documentation Portal

Build against the connector-neutral model, not one runtime's local vocabulary.

Connector definitions, capability metadata, data scopes, and policy presets all live in shared contracts. New integrations should extend those contracts instead of inventing transport-specific aliases.

Documentation map

The docs portal stays in the same application as the product shell so setup, deployment, connector, and developer guidance can evolve with the codebase.

In-repo docs7 foundation routes5 developer routesCurrent: Connector Model

Foundation docs

  • OverviewRoute

    Start with the current architecture, product surfaces, and the stable documentation sections.

  • Getting StartedRoute

    Install the workspace, configure local env files, and run the first verification flow.

  • DeploymentRoute

    Use the managed bridge deployment order, health checks, migrations, and workspace bootstrap flow.

  • ConnectorsRoute

    Understand the Figma reference connector, Satellite runtime, and explicit session routing model.

  • SecurityRoute

    Review auth lanes, workspace isolation, policy controls, rate limiting, and audit semantics.

  • API ReferenceRoute

    Browse the stable HTTP route groups, shared envelopes, auth lanes, and machine-readable errors.

  • TroubleshootingRoute

    Use the current operational failure patterns for readiness, auth, session liveness, policy, and MCP issues.

Developer docs

  • DevelopersRoute

    Developer-facing entry point for HTTP, MCP, connector, and shared-contract guidance.

  • Developer QuickstartRoute

    Bring up the bridge, connect one runtime, and make the first explicit authenticated calls.

  • HTTP GuideRoute

    Use the bridge HTTP transport with the correct auth lane, shared envelopes, and explicit targetSessionId routing.

  • MCP GuideRoute

    Use the Streamable HTTP MCP endpoint, LIST_CAPABILITIES, and the same connector-neutral tool catalog.

  • Connector ModelOpen

    Understand connector definitions, capability metadata, data scopes, and high-risk policy presets.

Connector catalog

The current shared catalog exposes one reference embedded-plugin connector and one Satellite runtime connector.

Figma

figmaembedded_plugin

Reference connector implemented through the Figma plugin runtime.

Capabilities: 27

High-risk capabilities: 0

Execution modes: none

Satellite Runtime

satellitesatellite_agent

Satellite-backed runtime entry point for desktop and restricted-network integrations.

Capabilities: 24

High-risk capabilities: 5

Execution modes: execute, plan, preview, simulate, validate

Capability and data-scope model

Capability metadata already carries command names, execution semantics, and output data scopes, so connector docs should reuse those fields directly.

NODE_IDSNODE_METADATATEXT_CONTENTDOCUMENT_METADATACONTEXT_REFERENCEBINARY_ASSET

SATELLITE_COMMAND_DESCRIPTOR

mediumpreview

Connector: satellite

Command type: SATELLITE_COMMAND_DESCRIPTOR

Output data scopes: TEXT_CONTENT

SATELLITE_COMMAND_EXECUTE

highexecute

Connector: satellite

Command type: SATELLITE_COMMAND_EXECUTE

Output data scopes: TEXT_CONTENT

SATELLITE_FILE_CHANGESET_APPLY

highexecute

Connector: satellite

Command type: SATELLITE_FILE_CHANGESET_APPLY

Output data scopes: TEXT_CONTENT

SATELLITE_FILE_CHANGESET_PLAN

mediumplan

Connector: satellite

Command type: SATELLITE_FILE_CHANGESET_PLAN

Output data scopes: TEXT_CONTENT

SATELLITE_FILE_CHANGESET_PREVIEW

mediumpreview

Connector: satellite

Command type: SATELLITE_FILE_CHANGESET_PREVIEW

Output data scopes: TEXT_CONTENT

SATELLITE_FILE_CHANGESET_SIMULATED_APPLY

highsimulate

Connector: satellite

Command type: SATELLITE_FILE_CHANGESET_SIMULATED_APPLY

Output data scopes: TEXT_CONTENT

SATELLITE_FILE_CHANGESET_VALIDATE

mediumvalidate

Connector: satellite

Command type: SATELLITE_FILE_CHANGESET_VALIDATE

Output data scopes: TEXT_CONTENT

SATELLITE_GIT_DIFF_SUMMARY

mediumpreview

Connector: satellite

Command type: SATELLITE_GIT_DIFF_SUMMARY

Output data scopes: DOCUMENT_METADATA

SATELLITE_GIT_STATUS_SUMMARY

mediumpreview

Connector: satellite

Command type: SATELLITE_GIT_STATUS_SUMMARY

Output data scopes: DOCUMENT_METADATA

SATELLITE_HOST_ACTION_EXECUTE

highexecute

Connector: satellite

Command type: SATELLITE_HOST_ACTION_EXECUTE

Output data scopes: DOCUMENT_METADATA

High-risk policy presets

The bounded Satellite execute paths already publish dedicated preset copy and fail-closed runtime requirements.

High-risk command execution

satellite-command-execute

Bridge policy must allow this capability before dispatch, but runtime-side command allowlisting remains a second required gate.

Runtime requirement: Only commands listed in SATELLITE_ALLOWED_COMMANDS may execute at the runtime boundary.

High-risk file apply

satellite-file-changeset-apply

Bridge policy must allow this capability before dispatch, and runtime-side base-directory allowlisting remains a second required gate.

Runtime requirement: Only base directories listed in SATELLITE_ALLOWED_BASE_DIRECTORIES may be written at the runtime boundary.

High-risk package script execution

satellite-package-script-execute

Bridge policy must allow this capability before dispatch, while runtime-side package-script allowlisting and base-directory allowlisting remain required gates.

Runtime requirement: Only script names listed in SATELLITE_ALLOWED_PACKAGE_SCRIPTS and base directories listed in SATELLITE_ALLOWED_BASE_DIRECTORIES may execute at the runtime boundary.

High-risk host action execution

satellite-host-action-execute

Bridge policy must allow structured Satellite host actions before dispatch, while runtime-side action allowlisting remains a second required gate.

Runtime requirement: Only action ids listed in SATELLITE_ALLOWED_ADAPTER_ACTION_IDS may execute at the runtime boundary, and only enabled adapter kinds may expose host actions.