docs(mcp): clarify micro-app build requirement and Python prereq in a2ui-in-mcpapps README#1686
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the README.md for the a2ui-in-mcpapps sample, clarifying that the Python version is managed by uv and explaining that the micro-apps must be built on a fresh checkout because they are git-ignored. The reviewer suggests simplifying the prerequisites section by listing only uv as a requirement, since it automatically downloads and manages the correct Python version.
becd467 to
1189f03
Compare
The top-level README for the a2ui-in-mcpapps sample marked the
micro-app build as "Optional" and described server/apps/public/
artifacts as present. In a fresh checkout those single-file HTML
artifacts are git-ignored and absent, so the Basic/Editor surfaces
fail to load until at least one app is built. Reword the section to
state the build is required for a surface to render (the server still
starts without it).
Also stop hardcoding "Python 3.10+" in the prerequisites and instead
point to server/.python-version as the source of truth, which uv
fetches automatically.
Verified end-to-end in a clean worktree: root yarn install,
client yarn build:sandbox (generates sandbox.{js,html}),
server uv sync + uv run python server.py --transport sse --port 8000
(SSE endpoint returns HTTP 200 text/event-stream), client ng serve
(index served HTTP 200), and server/apps/src yarn build:all generates
public/app.html.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Polina Cherkasova <polina.c@live.com>
…/readme-mcp-a2ui-in-mcpapps
josemontespg
approved these changes
Jun 17, 2026
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.
contributes to flutter/genui#907
What was unclear
While validating
samples/community/mcp/a2ui-in-mcpapps/README.mdend-to-end in a fresh worktree, two things were misleading:Micro-app build framed as purely "Optional." The server reads its surfaces from
server/apps/public/{app,editor}.html, but those single-file artifacts are git-ignored and absent in a fresh checkout. Following the README literally (skipping the "optional" step) starts the server but the Basic/Editor surfaces fail to load (Resource file not found). Reworded to state the build is required for a surface to render, while noting the server itself still starts without it.Hardcoded "Python 3.10+". Replaced with a pointer to
server/.python-version(the source of truth, whichuvfetches automatically) so the doc doesn't drift from the actual pin.What still works (verified, left unchanged)
yarn install(repo root) — OKcd client && yarn install && yarn build:sandbox— generatesclient/public/sandbox_iframe/sandbox.{js,html}cd server && uv sync && uv run python server.py --transport sse --port 8000—--transport sse/--portvalid;/ssereturns HTTP 200text/event-streamcd client && yarn start(ng serve) — index served HTTP 200 with<app-root>cd server/apps/src && yarn build:all— generatesserver/apps/public/app.htmlArchitecture, mermaid diagram, and communication-flow sections preserved. No code changes.