Skip to content

[MCP][iFrame] Add a guide for the iframe and MCP catalog packages - #2803

Draft
josemontespg wants to merge 1 commit into
catalogs-example-url-order-trackerfrom
catalogs-docs-guide
Draft

josemontespg wants to merge 1 commit into
catalogs-example-url-order-trackerfrom
catalogs-docs-guide

Conversation

@josemontespg

@josemontespg josemontespg commented Sep 25, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Add a developer guide for the @a2ui/catalog-iframe and @a2ui/catalog-mcp packages under docs/public/guides/iframe-and-mcp-catalogs.md and link to it from the catalog READMEs and the MkDocs navigation.

The guide covers when to use WebAppFrameSrcdoc, WebAppFrameUrl, and McpApp, installing the packages, serving and configuring the /a2ui-sandbox/ outer proxy asset with Angular CLI, Vite, and static servers, registering the A2UI v1.0 catalogs (@a2ui/web_core/v1_0, @a2ui/catalog-iframe, @a2ui/catalog-mcp/v1_0) with a web renderer, using the Node-safe @a2ui/catalog-mcp/v1_0/functions entry point, and troubleshooting common integration issues.

Changes

  • Add docs/public/guides/iframe-and-mcp-catalogs.md covering installation, sandbox asset deployment, catalog registration, example walkthroughs, wire protocols, Node function usage, and troubleshooting.
  • Register the guide in mkdocs.yaml under Guides.
  • Link to the guide from the Implementations sections of catalogs/iframe/README.md and catalogs/mcp/README.md.

Verification

  • ./scripts/fix_format.sh --check passed.
  • python3 scripts/fix_licenses.py --check passed.
  • Verified all relative Markdown links and anchors across docs/public/guides/iframe-and-mcp-catalogs.md, catalogs/iframe/README.md, catalogs/mcp/README.md, and mkdocs.yaml.

Pre-launch Checklist

  • I read the Contributors Guide.
  • My code changes have tests (documentation-only change; no code changes to test).

Related to #3157

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds a new comprehensive guide for Iframe and MCP catalogs, including updates to the respective README files and the documentation navigation. The review identified a contradiction between the guide's description of sandbox attributes and the actual specifications, as well as a missing action handler in the MessageProcessor example. Both issues require updates to ensure the documentation is accurate and the provided code examples are functional.

Comment thread docs/public/guides/iframe-and-mcp-catalogs.md
Comment thread docs/public/guides/iframe-and-mcp-catalogs.md Outdated
@josemontespg
josemontespg added this pull request to stack #2804 September 25, 2026 18:11
@josemontespg
josemontespg force-pushed the catalogs-docs-guide branch 2 times, most recently from f10cc20 to a6764f8 Compare September 25, 2026 20:21
@josemontespg
josemontespg removed this pull request from stack #2804 October 1, 2026 20:12
@josemontespg
josemontespg added this pull request to stack #2940 October 1, 2026 20:12
@josemontespg
josemontespg force-pushed the catalogs-docs-guide branch 2 times, most recently from b721eb6 to 98ba4fe Compare October 1, 2026 21:42
@josemontespg
josemontespg removed this pull request from stack #2940 October 1, 2026 21:56
@josemontespg
josemontespg added this pull request to stack #2946 October 1, 2026 21:56
@josemontespg
josemontespg force-pushed the catalogs-docs-guide branch 2 times, most recently from 85cc4ab to 9023a4f Compare October 1, 2026 22:41
@josemontespg
josemontespg removed this pull request from stack #2946 October 2, 2026 00:35
@josemontespg
josemontespg changed the base branch from catalogs-lit-explorer to catalogs-mcp-app-component October 2, 2026 00:35
@josemontespg
josemontespg removed this pull request from stack #2951 October 5, 2026 20:45
@josemontespg
josemontespg added this pull request to stack #3011 October 5, 2026 20:45
@josemontespg
josemontespg removed this pull request from stack #3011 October 7, 2026 23:18
@josemontespg
josemontespg changed the base branch from catalogs-mcp-app-component to main October 7, 2026 23:19
@josemontespg
josemontespg changed the base branch from main to catalogs-example-url-order-tracker October 7, 2026 23:19
@josemontespg
josemontespg added this pull request to stack #3055 October 7, 2026 23:19
@josemontespg
josemontespg removed this pull request from stack #3055 October 7, 2026 23:32
@josemontespg josemontespg changed the title docs: add a guide for the iframe and MCP catalog packages [MCP][iFrame] docs: add a guide for the iframe and MCP catalog packages Oct 7, 2026
@josemontespg
josemontespg added this pull request to stack #3057 October 7, 2026 23:34
@josemontespg josemontespg changed the title [MCP][iFrame] docs: add a guide for the iframe and MCP catalog packages [MCP][iFrame] Add a guide for the iframe and MCP catalog packages Oct 8, 2026
@josemontespg
josemontespg force-pushed the catalogs-docs-guide branch 2 times, most recently from cc8bac3 to 37c11e2 Compare October 8, 2026 20:31

This branch has not been deployed

No deployments
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