Create Canvas

Create a working canvas extension in the current workspace. Do the implementation rather than only returning a sample.

Clarify only when needed

The extension scope is fixed: create a project extension under .github/extensions/<name>/.

If the requested canvas purpose is unclear, ask what it should display or let the user do. If durable state is required but its identity or lifetime is ambiguous, ask whether the state belongs in a workspace artifact or private extension storage.

Inspect first

Before writing:

1. Check for existing .github/extensions/ conventions and reusable UI/server helpers.
2. Choose a short kebab-case extension folder name and a stable canvas ID.
3. Identify the domain identity for durable state, such as a file path, document ID, or record ID. instanceId identifies a panel, not its data.

Implement

Create .github/extensions/<name>/extension.mjs.

• Use ES modules and import createCanvas, CanvasError, and joinSession from @github/copilot-sdk/extension.
• Do not create a package.json or install @github/copilot-sdk; the runtime resolves it automatically.
• Never write to stdout with console.log. Use session.log() for diagnostics.
• Bind embedded HTTP servers to 127.0.0.1 on an ephemeral port.
• Return an HTTP URL from open(). Do not place credentials or private state in the URL.
• Treat open() as idempotent. Reopening the same instanceId must reuse or safely replace its live server and reload state from the stable domain identity.
• Use process.env.VSCODE_CANVAS_DATA_DIR for private durable extension data. Validate that it is an absolute path, create a child directory for the extension, and fail explicitly when it is unavailable.
• Store repo-owned artifacts at a sensible workspace path when the user expects them to be versioned or directly editable.
• Use semantic HTML, keyboard-accessible controls, visible focus, labels, and ARIA status text. The page has no privileged VS Code bridge; use ordinary same-origin HTTP endpoints or server-sent events.
• Escape untrusted values before inserting them into HTML and validate every HTTP and action input.

Declare the canvas with:

• a short single-sentence description;
• an optional inputSchema;
• agent-facing actions[];
• an open handler;
• an onClose handler that stops instance-owned servers.

Rules:

• If the canvas takes no input, omit inputSchema. If it declares an object schema, callers must open it with an object such as {}, not null.
• Action names must not start with canvas..
• Every action must have a handler and its own JSON Schema when it accepts input.
• Return raw action results. Throw new CanvasError(code, message) for expected failures.
• Do not rely on closing the VS Code canvas tab to call onClose; tab closure hides presentation only. Preserve the live instance so a later agent reopen can show the same state.

Keep extension.mjs focused on wiring. Put substantial HTML, CSS, client JavaScript, schemas, storage, and domain logic in sibling modules or asset files.

Validate

1. Run node --check .github/extensions/<name>/extension.mjs and the smallest relevant extension tests.
2. Call extensions_reload after creating or modifying the extension. This stops and restarts all extension providers; previously open canvases are rehydrated after their providers reconnect.
3. After reload, do not claim success until the runtime confirms the canvas:
   • call list_canvas_capabilities for the canvas ID;
   • call open_canvas with a stable instanceId and schema-valid input;
   • call at least one invoke_canvas_action when actions exist.
4. Close the canvas tab, ask the agent to reopen the same instance, and confirm the state is preserved.

Summarize the files created, the canvas and action IDs, where state is stored, and the reload and runtime verification results.