Thales Maciel
68d8e875e0
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
57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
# MCP Client Config Example
|
|
|
|
Recommended default for most chat hosts: `workspace-core`.
|
|
|
|
Use the host-specific examples first when they apply:
|
|
|
|
- Claude Code: [examples/claude_code_mcp.md](claude_code_mcp.md)
|
|
- Codex: [examples/codex_mcp.md](codex_mcp.md)
|
|
- OpenCode: [examples/opencode_mcp_config.json](opencode_mcp_config.json)
|
|
|
|
Use this generic config only when the host expects a plain `mcpServers` JSON
|
|
shape.
|
|
|
|
`pyro-mcp` is intended to be exposed to LLM clients through the public `pyro` CLI.
|
|
|
|
Generic stdio MCP configuration using `uvx`:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"pyro": {
|
|
"command": "uvx",
|
|
"args": ["--from", "pyro-mcp", "pyro", "mcp", "serve", "--profile", "workspace-core"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
If `pyro-mcp` is already installed locally, the same server can be configured with:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"pyro": {
|
|
"command": "pyro",
|
|
"args": ["mcp", "serve", "--profile", "workspace-core"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Profile progression:
|
|
|
|
- `workspace-core`: the recommended first persistent chat profile
|
|
- `vm-run`: expose only `vm_run`
|
|
- `workspace-full`: advanced 3.x compatibility surface for shells, services, snapshots, secrets, network policy, and disk tools
|
|
|
|
Primary profile for most agents:
|
|
|
|
- `workspace-core`
|
|
|
|
Use lifecycle tools only when the agent needs persistent VM state across multiple tool calls.
|
|
|
|
Other generic-client examples:
|
|
|
|
- Claude Desktop: [examples/claude_desktop_mcp_config.json](claude_desktop_mcp_config.json)
|
|
- Cursor: [examples/cursor_mcp_config.json](cursor_mcp_config.json)
|