Repository navigation
docs: show how to point uvx at an index hosting kirocrew - #33143
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. The [DESIGN-REVIEWED] 0896f63 Description read[DESCRIPTION-READ] 29c430b7dca6e549b0bcab748842616d8192e2e619d952f66421c4e81c13dd36 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 |
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: |
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 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.
d89c98d to
0896f63
Compare
|
KiroCrewCaptain
left a comment
There was a problem hiding this comment.
Approving. On this head the review checked several things. The stable / insider (rc) / nightly (.dev) rule matches the release and nightly workflows, and each channel publishes only its own simple index. ignore-error-codes = [403] matches how the CDN answers a missing key. The uv.toml paths are uv's standard user config locations. The install.md#installing-a-published-wheel-with-pip anchor resolves, and the failure text matches the reports on #23488.
Well done: each claim in the new text has a row in the manual verification table, including the two negative cases (no ignore-error-codes, and default = true losing the PyPI fallback). The guide then warns readers away from both.
- Optional: run one governed session with the uv.toml snippet in place and confirm the servers start through a Kiro CLI registry launch. The current proof runs
uvxdirectly. - Optional: after this merges, close #28559 as superseded by this PR, with credit to its author.
Problem / Motivation
Goal: An admin who copies the enterprise MCP governance guide's
pypiregistry example learns what fails whenuvxhas no index hosting thekirocrewwheel, and how to pointuvxat one.kirocrewis not on public PyPI, so the guide'spypientries launch asuvx kirocrew@<version> <subcommand>and fail unlessuvxcan reach an index that hosts the wheel. The guide states that requirement in one sentence before the example, but never shows how to makeuvxuse such an index, and two reporters on #23488 read the example as working by default.Builds on #28559 by @cruisercohen.
Why it matters
The reader is an enterprise admin configuring a governed fleet. Copying the example as written leaves every session without the Kiro Crew tools those entries serve, while
kiro-cli mcp liststill shows the servers as accepted, so nothing points at the cause. With the requirement stated but no way to meet it, the admin has to work out uv's index configuration alone, and the obvious attempt with the project's own release index fails.Not a goal
kirocrewto public PyPI.What changed (motivation → approach → change)
An admin who follows the guide without an index gets servers that are accepted and never start, and the guide gives no way to set one up. The fix documents both, through uv's own configuration, which works however kiro-cli reads the registry entry.
In
docs/guides/enterprise-mcp-governance.md, right after the registry example:kiro-cli mcp list, thenuvxfails withkirocrew was not found in the package registryuv.toml[[index]]snippetstablefor no prerelease suffix,insiderforrc,nightlyfor.dev), since each version is listed only on the channel that released it; it needsignore-error-codes = [403]because the CDN answers 403 for packages it does not host, and uv stops at a 403default = truewould drop it, and the index belongs in uv, not inregistryBaseUrlThe sentence before the example and the "Known limitation" section point at that setup rather than saying the organisation must mirror the wheel.
Backwards compatibility
Compatible: documentation only; no code, setting or interface changes.
Removes nothing: the only reworded sentences still state the same requirement (an index hosting the wheel) and no instruction is dropped.
Tests
N/A, documentation only.
./scripts/docs-lint.shandpython3 scripts/docs_lint.py --testpass.Manual verification
Checked with uv 0.12.3 on Linux,
uvx kirocrew@0.12.0 --help, eachuv.tomlin an isolatedXDG_CONFIG_HOME/uv/(the~/.config/uv/uv.tomlpath) with an isolated uv cache:uv.tomlkirocrew was not found in the package registry(the note's text)ignore-error-codes = [403])kirocrewfrom the CDN and its dependencies from PyPI; CLI help printsignore-error-codesdefault = trueThe CDN's three channel indexes list separate wheels:
stableends at0.12.0,insiderat0.12.0rc10,nightlyat a0.13.0.devbuild, so a version from one channel is missing from the others. The launch form (uvx kirocrew@<version> <subcommand>) comes from the two reports on #23488.https://pypi.org/pypi/kirocrew/jsonstill answers 404.Screenshots / video
N/A, documentation only: no frontend file changes.
Related Issues
Closes #23488
Sibling sweep
N/A: a
docs:PR, not a fix or revert.Pattern harvest
N/A: a
docs:PR, not a fix or revert.Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)Contribution License Agreement
This contribution is made under the project's Apache-2.0 license (see the Licensing section of CONTRIBUTING.md).