Skip to content

docs(mcp): clarify micro-app build requirement and Python prereq in a2ui-in-mcpapps README#1686

Merged
polina-c merged 3 commits into
mainfrom
docs/readme-mcp-a2ui-in-mcpapps
Jun 17, 2026
Merged

docs(mcp): clarify micro-app build requirement and Python prereq in a2ui-in-mcpapps README#1686
polina-c merged 3 commits into
mainfrom
docs/readme-mcp-a2ui-in-mcpapps

Conversation

@polina-c

@polina-c polina-c commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

contributes to flutter/genui#907

What was unclear

While validating samples/community/mcp/a2ui-in-mcpapps/README.md end-to-end in a fresh worktree, two things were misleading:

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

  2. Hardcoded "Python 3.10+". Replaced with a pointer to server/.python-version (the source of truth, which uv fetches automatically) so the doc doesn't drift from the actual pin.

What still works (verified, left unchanged)

  • yarn install (repo root) — OK
  • cd client && yarn install && yarn build:sandbox — generates client/public/sandbox_iframe/sandbox.{js,html}
  • cd server && uv sync && uv run python server.py --transport sse --port 8000--transport sse/--port valid; /sse returns HTTP 200 text/event-stream
  • cd client && yarn start (ng serve) — index served HTTP 200 with <app-root>
  • cd server/apps/src && yarn build:all — generates server/apps/public/app.html

Architecture, mermaid diagram, and communication-flow sections preserved. No code changes.

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

Comment thread samples/community/mcp/a2ui-in-mcpapps/README.md Outdated
@polina-c polina-c force-pushed the docs/readme-mcp-a2ui-in-mcpapps branch from becd467 to 1189f03 Compare June 17, 2026 15:48
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.
@a2ui-project a2ui-project deleted a comment from google-cla Bot Jun 17, 2026
polina-c and others added 2 commits June 17, 2026 12:53
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>
@polina-c polina-c merged commit a03f71a into main Jun 17, 2026
15 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in A2UI Jun 17, 2026
@polina-c polina-c deleted the docs/readme-mcp-a2ui-in-mcpapps branch June 17, 2026 20:47
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.

2 participants