Skip to content

docs(examples): the agui-events service needs the [api] extra - #77

Merged
ciaransweet merged 1 commit into
mainfrom
docs/agui-events-api-extra
Aug 13, 2026
Merged

docs(examples): the agui-events service needs the [api] extra#77
ciaransweet merged 1 commit into
mainfrom
docs/agui-events-api-extra

Conversation

@ciaransweet

Copy link
Copy Markdown
Contributor

The command this README gives cannot start the service from a clean checkout.

mcp_agent_api ships in the base wheel, so the import gets as far as
mcp_agent_api.events, which imports ag_ui. That comes from
ag-ui-protocol, which lives in the [api] extra — and the command never asks
for it. uv run builds the environment from the command alone, so a fresh
clone installs 71 packages and dies on:

ModuleNotFoundError: No module named 'ag_ui'

A checkout developed with uv sync --all-extras already has the extra and
never sees this, which is how it survived.

The change

--extra api on the command, plus a paragraph saying why it is not optional —
the failure names ag_ui rather than the extra, and mcp_agent_api importing
far enough to look installed is exactly what makes it confusing.

One extra is enough: api = ["mcp-toolsets-runtime[agent]", "ag-ui-protocol"],
so [agent] arrives with it. 78 packages against 71.

Verified in a throwaway environment rather than the repo's own venv, since the
symptom only reproduces where the extra is absent. With it the service boots:
connected 4 MCP server(s), built on mistral-small-latest: 5 tool(s), 1 withheld, and /health/readiness answers 200 {"status": "ready"}.

Also corrects "the agent's four routes" to five, twenty lines down. It has been
five since #73service/app.py's docstring was corrected then and this was
missed.

Reported by a colleague hitting it on a first run, which is the only place it
can be hit.

🤖 Generated with Claude Code

The README's own command omits --extra api, so a clean checkout dies on
ModuleNotFoundError: No module named 'ag_ui'. mcp_agent_api ships in the
base wheel and imports far enough to look installed; ag-ui-protocol, which
events.py needs, is in the extra.

Also corrects "four routes" to five, unchanged since #73.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@ciaransweet
ciaransweet merged commit c76a274 into main Aug 13, 2026
4 checks passed
@ciaransweet
ciaransweet deleted the docs/agui-events-api-extra branch August 13, 2026 12:13
ciaransweet pushed a commit that referenced this pull request Aug 13, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.5.5](mcp-toolsets-runtime-v0.5.4...mcp-toolsets-runtime-v0.5.5)
(2026-08-13)


### Documentation

* **examples:** the agui-events service needs the [api] extra
([#77](#77))
([c76a274](c76a274))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: ds-release-bot[bot] <116609932+ds-release-bot[bot]@users.noreply.github.com>
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