mcp: document register_resource usage + overlay + self-contained HTML

[Andrew Gazelka (andrewgazelka)]

What

Expand the register_resource docstring (surfaced via api() / help()) to cover how to use it properly:

• Stable id replaces in place (a loop updating one view) vs. a random id spawning a new pane each call.
• Live vs. static — render is re-invoked on refresh (contrast with cells).
• alive predicate auto-closes the resource.
• Viewing as a native overlay — nix run .#ix-windows renders each live resource as a floating, blurred, auto-sizing window (drag by the chrome, not resizable).
• Self-contained HTML rule — the body runs in a sandboxed, opaque-origin iframe (allow-scripts, no allow-same-origin) in both the dashboard and the overlay, so inline all CSS/JS/data; pre-render anything needing a library (e.g. mermaid -> SVG via kroki/CLI), since CDN scripts silently fail.

Docstring-only; parses clean, lines ≤88.

🤖 Authored with Claude Code (Opus).

Note

Document register_resource usage with overlay, iframe, and self-contained HTML guidance

Expands the docstring for register_resource in runtime.py with structured documentation covering argument behaviors, stable ID guidance, auto-closing semantics, overlay window rendering via ix-windows, iframe sandboxing and origin constraints, and a recommendation to prefer self-contained HTML for external asset compatibility. No executable code changes.

^{Macroscope summarized 8a4e94f.}

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

[github-actions]

AI review found issues in this pull request.

Verdict: patch is incorrect
Confidence: 0.90

The patch is documentation-only, but it introduces materially incorrect API guidance about sandboxed resource panes and external CDN loading.

• P2 packages/mcp/ix_notebook_mcp/runtime.py:827 Misleading docs say CDN scripts/styles are blocked

[github-actions]

Blast radius

62 of 1485 checks would rebuild between base d75b6ab and head 6947477.

pie showData title Rebuilt checks by category
  "rust" : 41
  "image" : 15
  "site" : 2
  "agent" : 1
  "blast" : 1
  "eval" : 1
  "lint" : 1

Loading

flowchart LR
  c0["ix-notebook-mcp-module"]
  c1["blast-radius-test"]
  c2["agent-skills"]
  c3["lint"]
  c4["rust-mcp.viewSmoke"]
  c5["site-test"]
  c0 --> k0["agent-skills"]
  c0 --> k2["eval"]
  c0 --> k3["image-development-base"]
  c0 --> k4["image-kernel-dev"]
  c0 --> k5["image-minecraft"]

Loading

changed checks (62)

• agent-skills
• blast-radius-test
• eval
• image-development-base
• image-kernel-dev
• image-minecraft
• image-minecraft-bedrock
• image-minecraft-status
• image-minecraft_1.21.11-fabric
• image-minecraft_1.21.11-paper
• image-minecraft_26.1.2-fabric
• image-minecraft_26.1.2-paper
• image-minecraft_26w17a-fabric
• image-minestom
• image-neovim-ci
• image-remote-desktop
• image-symphony-codex
• image-test-cluster-bootstrap
• lint
• rust-mcp.apiSmoke
• rust-mcp.astlogBundled
• rust-mcp.beeperBundled
• rust-mcp.bindDefaultSmoke
• rust-mcp.bindingsSmoke
• rust-mcp.browserSmoke
• rust-mcp.browserVdomSmoke
• rust-mcp.dataLibsBundled
• rust-mcp.engineBundled
• rust-mcp.evalSmoke
• rust-mcp.exaBundled
• rust-mcp.feedSmoke
• rust-mcp.fffBundled
• rust-mcp.fleetClusterSmoke
• rust-mcp.fleetSmoke
• rust-mcp.gmailLibsBundled
• rust-mcp.googleAuthBundled
• rust-mcp.htpyBundled
• rust-mcp.iphoneBundled
• rust-mcp.ixGoogleBundled
• rust-mcp.linearBundled
• rust-mcp.nixSmoke
• rust-mcp.noxAutotriageBundled
• rust-mcp.requirementsSmoke
• rust-mcp.richSmoke
• rust-mcp.runtimeSmoke
• rust-mcp.searchBundled
• rust-mcp.serverTools
• rust-mcp.sessionIdentitySmoke
• rust-mcp.sessionSmoke
• rust-mcp.shSmoke
• rust-mcp.slackBundled
• rust-mcp.sshAuthSockSmoke
• rust-mcp.strictTypecheck
• rust-mcp.tuiBundled
• rust-mcp.vdomPropertiesSmoke
• rust-mcp.viewSmoke
• rust-mcp.wedgeSmoke
• rust-mcp.worktreeSmoke
• rust-mcp.xBundled
• rust-mcp.yieldSmoke
• site-case-tests
• site-test