Skip to content

Documentation versions

MCP and shared editing ​

The Binary GIN sidebar combines the converter with MCP connections. Several clients can work with the same live VS Code document. You can see their edits, actions and renders and intervene through normal editing.

Download and connect ​

The MCP adapter is bundled in the VSIX starting with 0.6.3. There is no separate MCP download, Python installation, pip setup, or Zstd compilation.

  1. Download the VSIX for your platform from release 0.6.3 and install the extension.
  2. Open a trusted workspace and a BGIN file in VS Code.
  3. Open Binary GIN → MCP connections in the left sidebar.
  4. Click Copy MCP configuration and paste it into your MCP client's settings. For clients using another configuration wrapper, copy its command and args.
  5. Start the connection in your client. Its name and actions appear in VS Code.

Copy client command copies a PowerShell command on Windows or a shell command on macOS/Linux. It runs the bundled bgin_backend with --mcp. The path already points to your installed extension. Give each client its own --client-name.

json
{
  "mcpServers": {
    "bgin": {
      "command": "<absolute path to bundled bgin_backend>",
      "args": ["--mcp", "--mode", "connected", "--editor-bridge", "<connection file>", "--client-name", "My assistant"]
    }
  }
}

Use the button to obtain real paths rather than copying these placeholders. The connection file contains a local access key; keep it out of shared archives. If reinstalling the extension or changing windows invalidates a path, copy the settings again. With WSL, SSH, or containers, run the adapter in the same execution environment as the extension; remote paths cannot run on the local host.

Rendering requires Chrome or Microsoft Edge installed where the adapter runs. The browser driver is already bundled; connecting does not download a browser. Reading and editing work without a browser. Rendering reports an error when no supported browser is available.

An unavailable window causes an explicit error; connected mode never falls back to a detached disk copy. Standalone file operations require explicit --mcp --mode standalone.

What the user and model see ​

A client starts with bgin_editor, then reads through bgin_read. Edits provide the returned revision as base_revision and a unique operation_id. The revision is checked again after validation. Concurrent changes cause a conflict and require rereading the document. Retrying an already applied operation ID does not apply the edit twice.

Manual unsaved changes are part of the shared document. Temporarily invalid JSON remains the current text; clients do not receive a hidden last-valid copy. Changes use normal VS Code Undo/Redo. Writing to disk requires explicit saving, which preserves the source BGIN format.

Subscribing to bgin://editor/state reports changes. The server sends the event, but whether and when it enters an already running model's context depends on the MCP client. Revision checks prevent stale edits from being applied.

Intervene ​

The sidebar lists clients, operations and recent events. You can:

  • Open an affected document and edit it manually.
  • Pause a client's edits and resume them later.
  • Stop an operation that has not yet been applied.
  • Disconnect a client session.

Stopping does not undo previous changes; use Undo for those. Client renders appear in a gallery with their author. Document changes mark earlier results stale. Resources are shared with the workspace. The result remains a preview, not a running game.