Repository navigation
[MCP] Add MCP catalog guide and align MCP Apps guide - #3642
Open
josemontespg wants to merge 1 commit into
Open
josemontespg wants to merge 1 commit into
josemontespg wants to merge 1 commit into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive guide for the MCP catalog (mcp-catalog.md), updates the navigation in mkdocs.yaml, and links to the new guide from catalogs/mcp/README.md. The review feedback suggests minor grammatical and punctuation improvements in both the README and the new guide, including updating a version reference to 'v1.0 or later' for forward compatibility. Additionally, it is recommended to update the troubleshooting section to suggest deduplicating @a2ui/web_core alongside lit in Vite configurations to prevent duplicate instance issues.
josemontespg
commented
Oct 26, 2026
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 26, 2026 22:04
7c923e8 to
619e3ce
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 26, 2026 23:14
619e3ce to
52a5d4c
Compare
josemontespg
changed the base branch from
catalogs-docs-guide
to
catalogs-mcp-filesystem-sample-v1
October 26, 2026 23:14
josemontespg
changed the base branch from
catalogs-mcp-filesystem-sample-v1
to
catalogs-mcp-kanban-functions
October 27, 2026 00:30
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 27, 2026 00:30
52a5d4c to
5ef3998
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 27, 2026 17:47
5ef3998 to
bd71a59
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 27, 2026 18:33
bd71a59 to
21001c6
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 28, 2026 21:30
21001c6 to
0cbe781
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 28, 2026 22:25
0cbe781 to
aa7eda3
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 28, 2026 22:43
aa7eda3 to
14cb7c3
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 00:27
0c4ab00 to
7b2f020
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 01:03
7b2f020 to
cec5b55
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 17:15
cec5b55 to
62f4f64
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 17:36
62f4f64 to
3a3d0a0
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 18:30
3a3d0a0 to
5803bb3
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
2 times, most recently
from
October 29, 2026 19:01
e505739 to
72d4676
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
2 times, most recently
from
October 29, 2026 20:40
7c40176 to
8cb1dda
Compare
josemontespg
changed the title
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 22:04
8cb1dda to
40075ef
Compare
josemontespg
marked this pull request as ready for review
October 30, 2026 19:19
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 30, 2026 20:58
40075ef to
65ee808
Compare
Add docs/public/guides/mcp-catalog.md introducing MCP for developers new to it and walking through setting up @a2ui/catalog-mcp, calling MCP tools from UI components (targetDataPath and the four data functions), embedding and styling sandboxed McpApp widgets, and collapsible advanced configuration and troubleshooting. Update docs/public/guides/mcp-apps-in-a2ui.md as the companion architecture and runnable-samples guide: document McpApp's sandbox='allow-scripts' isolation and v1.0 JSON-RPC channels, replace the obsolete pre-v1.0 custom-component snippet with a link to mcp-catalog.md, lead with the v1.0 Kanban showcase, and fold pre-v1.0 samples into a collapsible section. Group all four MCP guides under A2UI + MCP in mkdocs.yaml. Related to #3157
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 30, 2026 21:41
65ee808 to
77798c0
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a practical setup and usage guide for
@a2ui/catalog-mcpatdocs/public/guides/mcp-catalog.mdand alignsdocs/public/guides/mcp-apps-in-a2ui.mdas its companion architecture and runnable-samples guide underA2UI + MCP.mcp-catalog.mdintroduces MCP for developers new to it and walks throughconfigureMcpCatalog, client-side tool calls (targetDataPathand the four data functions),McpAppembedding and CSS variables, and collapsible advanced configuration.mcp-apps-in-a2ui.mddocumentsMcpApp'ssandbox="allow-scripts"double-iframe isolation and v1.0 JSON-RPC channels, removes the obsolete pre-v1.0 custom-component snippet in favor of linking tomcp-catalog.md, leads with the v1.0 Kanban showcase, and folds pre-v1.0 samples into a collapsible block.Running docs previews: MCP Catalog and MCP Apps in A2UI
Changes
docs/public/guides/mcp-catalog.mdcovering@a2ui/catalog-mcpsetup,callMcpTool, data functions,McpApp, collapsible advanced configuration, and troubleshooting.docs/public/guides/mcp-apps-in-a2ui.mdto focus on double-iframe isolation, v1.0 JSON-RPC communication channels, and the v1.0 Kanban showcase (with pre-v1.0 samples collapsed).catalogs/mcp/README.mdand group all four MCP guides underA2UI + MCPinmkdocs.yaml.Verification
yarn format:check:alland typechecked the guide's TypeScript snippets against@a2ui/catalog-mcpand@a2ui/angular.mkdocs buildandmkdocs serve) and verified that all internal anchors, Mermaid diagrams, admonitions, and relative file links resolve (external links are checked by lychee in CI).