Ship first-class MCP setup examples for Claude Code, Codex, and OpenCode so new users can copy one exact command or config instead of translating the generic MCP template by hand. Reposition the docs to surface those host-specific examples before the generic config fallback, keep workspace-core as the recommended profile everywhere user-facing, and retain Claude Desktop/Cursor as secondary fallback examples. Bump the package and catalog to 3.11.0, mark the roadmap milestone done, and add docs-alignment coverage that pins the new examples to the canonical workspace-core server command and the expected OpenCode config shape. Validation: - uv lock - ./.venv/bin/pytest --no-cov tests/test_cli.py - UV_CACHE_DIR=.uv-cache make check - UV_CACHE_DIR=.uv-cache make dist-check
56 lines
2 KiB
Markdown
56 lines
2 KiB
Markdown
# `3.11.0` Host-Specific MCP Onramps
|
|
|
|
Status: Done
|
|
|
|
## Goal
|
|
|
|
Remove the last translation step for major chat hosts by shipping exact,
|
|
copy-pasteable MCP setup guidance for the hosts users actually reach for.
|
|
|
|
## Public API Changes
|
|
|
|
No core runtime or workspace API change is required in this milestone.
|
|
|
|
The main user-visible additions are host-specific integration assets and docs:
|
|
|
|
- Claude setup should have a first-class maintained example
|
|
- Codex should have a first-class maintained example
|
|
- OpenCode should have a first-class maintained example
|
|
- the integrations docs should show the shortest working path for each host and
|
|
the same recommended `workspace-core` profile
|
|
|
|
## Implementation Boundaries
|
|
|
|
- keep the underlying server command the same:
|
|
`pyro mcp serve --profile workspace-core`
|
|
- treat host-specific configs as thin wrappers around the same MCP server
|
|
- cover both package-without-install and already-installed variants where that
|
|
materially improves copy-paste adoption
|
|
- keep generic MCP config guidance, but stop forcing users of major hosts to
|
|
translate it themselves
|
|
|
|
## Non-Goals
|
|
|
|
- no client-specific runtime behavior hidden behind host detection
|
|
- no broad matrix of every MCP-capable editor or agent host
|
|
- no divergence in terminology between host examples and the public contract
|
|
|
|
## Acceptance Scenarios
|
|
|
|
- a Claude user can copy one shipped example and connect without reading generic
|
|
MCP docs first
|
|
- a Codex user can copy one shipped example or exact `codex mcp add ...` command
|
|
- an OpenCode user can copy one shipped config snippet without guessing its MCP
|
|
schema shape
|
|
- the README and integrations docs point to those host-specific examples from
|
|
the first integration pass
|
|
|
|
## Required Repo Updates
|
|
|
|
- new shipped config examples for Codex and OpenCode
|
|
- README, install docs, and integrations docs updated to point at the new host
|
|
examples
|
|
- at least one short host-specific quickstart section or example command for
|
|
each supported host family
|
|
- runnable or documented verification steps that prove the shipped examples stay
|
|
current
|