Skip to content

docs: add agent-bundle walkthrough canvas - #342

Merged
ScriptedAlchemy merged 1 commit into
mainfrom
docs/walkthrough-canvas
Sep 3, 2026
Merged

docs: add agent-bundle walkthrough canvas#342
ScriptedAlchemy merged 1 commit into
mainfrom
docs/walkthrough-canvas

Conversation

@ScriptedAlchemy

Copy link
Copy Markdown
Owner

Summary

  • Adds the agent-bundle end-to-end walkthrough canvas (docs/canvases/agent-bundle-walkthrough.canvas.tsx) to the repo, current as of the feat(cursor): support workspace/open event routes as fire-and-forget observation #298 workspace/open correction (Cursor observe-only supported).
  • Covers the authoring model, compile pipeline, per-host emission matrix with real emitted bytes, the hooks wire trace (native stdin -> IPC -> warm Flight render -> host response), event-family x host matrices, MCP tools flow, and the dev loop.

Test plan

  • Docs-only; canvas TypeScript check reported no errors at authoring time

@changeset-bot

changeset-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b164472

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ScriptedAlchemy
ScriptedAlchemy merged commit fd5705d into main Sep 3, 2026
4 checks passed
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 3, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-03T00:14:55.042698Z b164472 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b164472b38

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +399 to +403
conventional file whose path is its identity. A route module is one
async default Server Component plus statically extractable
<Text as="span" weight="semibold"> config</Text>,
<Text as="span" weight="semibold"> inputSchema</Text>, and
<Text as="span" weight="semibold"> resultSchema</Text> exports — there is no

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Scope the schema-export contract to applicable MCP routes

This presents config, inputSchema, and resultSchema as requirements for every route module, but the compiler applies that contract only to generated MCP tool/resource/prompt routes. MCP Apps skip validateRouteModuleContract, event routes require only an async default component, scripts have a separate contract, and providers are factories. As written, the walkthrough directs authors of several route kinds to add exports that are not part of their API; qualify this paragraph by route kind.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed on main in #356 (merge 16653ad); managed canvas copy updated identically.

"event": "tool/before",
"hostContractRevision": "2.1.250",
"target": "claude",
"native": { ...the stdin envelope, byte-for-byte... }

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove the byte-for-byte claim from the IPC request

The wrapper does not forward the stdin envelope byte-for-byte: it parses stdin with JSON.parse, stores the resulting object, and requestEventRuntime serializes a newly constructed request with JSON.stringify. Consequently whitespace, key formatting, and duplicate-key representation are lost before the socket write. Describe this as preserving the validated envelope value rather than its original bytes.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed on main in #356 (merge 16653ad); managed canvas copy updated identically.

Comment on lines +568 to +569
each target's adapter revision, capability-table hash, and the sha256 of every
pinned host schema it was validated against. agent-bundle.hooks.json is the

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Stop claiming manifests record capability-table hashes

The artifact manifest target record contains only adapterRevision, name, observedVersion, and schemas; neither manifestTargets nor ArtifactManifestTarget emits a capability-table hash. This provenance promise therefore cannot be verified from a built artifact. Remove the claim or add an actual manifest field before documenting it.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed on main in #356 (merge 16653ad); managed canvas copy updated identically.

n={5}
title="Thin client prints the host-native response and exits 0"
channel="wrapper → Claude · stdout"
note="Claude blocks the Write and surfaces the reason to the model. If the route had allowed it, the wrapper would print nothing (or updatedInput / additionalContext) instead."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document Claude's explicit allow response

For a Claude tool/before route that allows the call without context or updated input, projectEventDocument still returns hookSpecificOutput with hookEventName and permissionDecision: "allow", so the wrapper prints JSON rather than nothing. This note gives the wrong expected wire behavior for the ordinary allow case and should show the explicit allow response.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed on main in #356 (merge 16653ad); managed canvas copy updated identically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant