Repository navigation
[MCP] Add a guide for the MCP catalog package - #3642
Draft
josemontespg wants to merge 1 commit into
Draft
josemontespg wants to merge 1 commit into
josemontespg wants to merge 1 commit into
Conversation
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 28, 2026 22:46
14cb7c3 to
fefafdc
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 28, 2026 22:50
fefafdc to
ab0bc69
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 28, 2026 23:22
ab0bc69 to
2f9b0aa
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 28, 2026 23:43
2f9b0aa to
0c4ab00
Compare
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 00:27
0c4ab00 to
7b2f020
Compare
Add docs/public/guides/mcp-catalog.md covering @a2ui/catalog-mcp installation, registering mcpCatalog and configureMcpCatalog with MessageProcessor, serving the /a2ui-sandbox/ proxy asset, the callMcpTool payload and targetDataPath (latest call wins), the four data functions (transformData, updateDataModel, split, regexCapture) with the portable regex subset, adding your own functions in a separate catalog, and configuring McpApp properties and CSS variables. Link to the guide from catalogs/mcp/README.md and mkdocs.yaml. Related to #3157
josemontespg
force-pushed
the
catalogs-mcp-docs-guide
branch
from
October 29, 2026 01:03
7b2f020 to
cec5b55
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 guide for
@a2ui/catalog-mcpatdocs/public/guides/mcp-catalog.md. It covers installing the package, registeringmcpCatalogwithconfigureMcpCatalog, serving the/a2ui-sandbox/proxy asset thatMcpApploads, calling tools and shaping their results, and embedding and stylingMcpApp.The tool section explains the payload
callMcpToolreturns (toolName,toolInput,toolResult,structuredContent,textandjson) and howtargetDataPathwrites that payload. It also states the latest-call rule: a response that arrives after a newer call to the same path is not written. The guide gives two rules for this. Use onetargetDataPathper feature, and for autocomplete bind totargetDataPathinstead of chainingupdateDataModel, because the guard does not coverupdateDataModel.It then documents the four data functions (
transformDatawith itsjmespathargument,updateDataModel,splitandregexCapture), the portable regex subset, and why the set is closed. It ends with how a host adds its own parser in a separate catalog with its owncatalogId, and links to the package README for the full reference.Changes
docs/public/guides/mcp-catalog.md: the new guide, with examples taken frommcp-json-tool-result.jsonandmcp-text-tool-result.jsonand a customparseCsvcatalog snippet.catalogs/mcp/README.md: links to the guide.mkdocs.yaml: adds the guide to the Guides navigation.Verification
./scripts/fix_format.sh: clean.