Skip to content

[MCP] Add a guide for the MCP catalog package - #3642

Draft
josemontespg wants to merge 1 commit into
catalogs-mcp-kanban-functionsfrom
catalogs-mcp-docs-guide
Draft

josemontespg wants to merge 1 commit into
catalogs-mcp-kanban-functionsfrom
catalogs-mcp-docs-guide

Conversation

@josemontespg

@josemontespg josemontespg commented Oct 26, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

This PR adds a guide for @a2ui/catalog-mcp at docs/public/guides/mcp-catalog.md. It covers installing the package, registering mcpCatalog with configureMcpCatalog, serving the /a2ui-sandbox/ proxy asset that McpApp loads, calling tools and shaping their results, and embedding and styling McpApp.

The tool section explains the payload callMcpTool returns (toolName, toolInput, toolResult, structuredContent, text and json) and how targetDataPath writes 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 one targetDataPath per feature, and for autocomplete bind to targetDataPath instead of chaining updateDataModel, because the guard does not cover updateDataModel.

It then documents the four data functions (transformData with its jmespath argument, updateDataModel, split and regexCapture), 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 own catalogId, and links to the package README for the full reference.

Changes

  • docs/public/guides/mcp-catalog.md: the new guide, with examples taken from mcp-json-tool-result.json and mcp-text-tool-result.json and a custom parseCsv catalog snippet.
  • catalogs/mcp/README.md: links to the guide.
  • mkdocs.yaml: adds the guide to the Guides navigation.

Verification

  • ./scripts/fix_format.sh: clean.
  • I checked that every relative link in the guide points to an existing file. CI's lychee step checks the external links.

@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 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.

Comment thread catalogs/mcp/README.md Outdated
Comment thread docs/public/guides/mcp-catalog.md Outdated
Comment thread docs/public/guides/mcp-catalog.md Outdated
Comment thread docs/public/guides/mcp-catalog.md
@josemontespg
josemontespg removed this pull request from stack #3643 October 26, 2026 22:01
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 7c923e8 to 619e3ce Compare October 26, 2026 22:04
@josemontespg
josemontespg added this pull request to stack #3645 October 26, 2026 22:04
@josemontespg
josemontespg removed this pull request from stack #3645 October 26, 2026 23:14
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 619e3ce to 52a5d4c Compare October 26, 2026 23:14
@josemontespg
josemontespg changed the base branch from catalogs-docs-guide to catalogs-mcp-filesystem-sample-v1 October 26, 2026 23:14
@josemontespg
josemontespg added this pull request to stack #3647 October 26, 2026 23:17
@josemontespg
josemontespg removed this pull request from stack #3647 October 27, 2026 00:30
@josemontespg
josemontespg changed the base branch from catalogs-mcp-filesystem-sample-v1 to catalogs-mcp-kanban-functions October 27, 2026 00:30
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 52a5d4c to 5ef3998 Compare October 27, 2026 00:30
@josemontespg
josemontespg added this pull request to stack #3649 October 27, 2026 00:32
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 5ef3998 to bd71a59 Compare October 27, 2026 17:47
@josemontespg
josemontespg removed this pull request from stack #3649 October 27, 2026 18:27
@josemontespg
josemontespg added this pull request to stack #3661 October 27, 2026 18:29
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from bd71a59 to 21001c6 Compare October 27, 2026 18:33
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 21001c6 to 0cbe781 Compare October 28, 2026 21:30
@josemontespg
josemontespg removed this pull request from stack #3661 October 28, 2026 22:24
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 0cbe781 to aa7eda3 Compare October 28, 2026 22:25
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from aa7eda3 to 14cb7c3 Compare October 28, 2026 22:43
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 14cb7c3 to fefafdc Compare October 28, 2026 22:46
@josemontespg
josemontespg added this pull request to stack #3730 October 28, 2026 22:46
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from fefafdc to ab0bc69 Compare October 28, 2026 22:50
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from ab0bc69 to 2f9b0aa Compare October 28, 2026 23:22
@josemontespg
josemontespg removed this pull request from stack #3730 October 28, 2026 23:42
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 2f9b0aa to 0c4ab00 Compare October 28, 2026 23:43
@josemontespg
josemontespg added this pull request to stack #3733 October 28, 2026 23:44
@josemontespg
josemontespg removed this pull request from stack #3733 October 29, 2026 00:22
@josemontespg
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 0c4ab00 to 7b2f020 Compare October 29, 2026 00:27
@josemontespg
josemontespg added this pull request to stack #3737 October 29, 2026 00:28
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
josemontespg force-pushed the catalogs-mcp-docs-guide branch from 7b2f020 to cec5b55 Compare October 29, 2026 01:03

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