Repository navigation
docs(mcp-governance): show how to point uvx at a kirocrew mirror - #28559
cruisercohen wants to merge 1 commit into
Conversation
First Principles Review (Opus 5.5) — ⏭️ skippedRevision |
UX Review (Opus 5.5) — ⏭️ skippedRevision |
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS Docs-only change, and it fixes the stated problem: the copy-paste trap gets an explicit warning and a mirror setup that only uses uv's own config. Notes
[DESIGN-REVIEWED] be79740 Description read[DESCRIPTION-READ] 43ec905cc70c566536f28e6265f7a456955607352cdc36b98b621b49087a8247 That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
Opus 5.5 Review — ✅ no blocking findingsReviewed Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
The registry example cannot launch without a private index hosting the kirocrew wheel. Say so before the reader copies it, show the failure they will see, and show how to point uvx at the mirror through uv's own config. Fixes #23488
a43fe2a to
be79740
Compare
|
Opus 5.5 Review finding on a43fe2a ( |
GPT 6.1 Review — ✅ no blocking findingsGPT 6.1 completed its review of This comment is updated in place on each push. Review detailsNo findings. False positive or not applicable? A repository writer can comment: |
|
Thanks for this PR. The CI run on this head never got runners, so its jobs were cancelled, and the branch is based on an older main. Could you update it onto the latest main (rebase or merge)? That starts a fresh CI run against current main, and we will review it once it is green. |
|
[operator: bolichen97] Continuing this in #33143; thanks for the start. |
The enterprise MCP governance guide says its pypi registry example needs an index hosting the kirocrew wheel, but never shows how to make uvx use one, and a reader who copies the example sees accepted servers that never start. Describe that failure after the example, show the uv index configuration for the release CDN's per-channel index (picked by the fleet's version, since each version is listed only on the channel that released it; the CDN answers 403 for packages it does not host, so uv needs ignore-error-codes to move on to PyPI) or an organisation's own index, and say why default = true would drop PyPI for the wheel's dependencies. Builds on #28559.
The enterprise MCP governance guide says its pypi registry example needs an index hosting the kirocrew wheel, but never shows how to make uvx use one, and a reader who copies the example sees accepted servers that never start. Describe that failure after the example, show the uv index configuration for the release CDN's per-channel index (picked by the fleet's version, since each version is listed only on the channel that released it; the CDN answers 403 for packages it does not host, so uv needs ignore-error-codes to move on to PyPI) or an organisation's own index, and say why default = true would drop PyPI for the wheel's dependencies. Builds on #28559.
Problem / Motivation
Goal: The enterprise MCP governance guide tells an admin, before they copy the registry example, that it cannot launch without a private index hosting the
kirocrewwheel, and shows how to pointuvxat that index.kirocrewis not on public PyPI, so the guide'spypientries launch asuvx kirocrew@<version> mcp-coreand fail; the session gets none of Kiro Crew's tools. The guide states the mirror requirement in one sentence before the example, but two reporters on #23488 read the example as working by default, and the guide never shows how to pointuvxat a mirror.Why it matters
The reader is an enterprise admin configuring a governed fleet. Copying the example as written leaves every session without Kiro Crew's tools, while
kiro-cli mcp liststill shows the servers as accepted, so nothing points at the cause.Not a goal
What changed (motivation → approach → change)
Observed: the example fails without a mirror, and the guide gives no way to configure one. Approach: document the failure and the mirror setup through uv's own configuration, which does not depend on how kiro-cli parses the registry entry. Change, after the JSON example:
versiondoes not help;uv.toml[[index]]snippet with the per-OS file path, withoutdefault = true, so uv still falls back to PyPI for the wheel's dependencies; the guide saysdefault = trueis only for an index that proxies PyPI or hosts every dependency;registryBaseUrltouvx, so readers should not rely on that field;Backwards compatibility
Documentation only. No documented capability is removed.
Tests
N/A, documentation.
./scripts/docs-lint.shpasses locally with no finding on this file.Manual verification
The launch form (
uvx kirocrew@<version> <subcommand>) and the failure text are taken from the two reports on #23488. Theuv.toml[[index]]form is uv's documented index configuration; an index listed withoutdefault = trueis checked before PyPI, which stays the fallback.Screenshots / video
N/A, documentation.
Related Issues
Fixes #23488 (together with #23494 for the server list).
Checklist
Contribution License Agreement
This contribution is made under the project's Apache-2.0 license (see the Licensing section of CONTRIBUTING.md).