Thales Maciel
407c805ce2
Make the recommended MCP profile visible from the first help and docs pass without changing 3.x behavior. Rework help, top-level docs, public-contract wording, and shipped MCP/OpenAI examples so is the recommended first profile while stays the compatibility default for full-surface hosts. Bump the package and catalog to 3.8.0, mark the roadmap milestone done, and add regression coverage for the new MCP help and docs alignment. Validation included uv lock, targeted profile/help tests, make check, make dist-check, and a real guest-backed server smoke.
48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
# MCP Client Config Example
|
|
|
|
Recommended default for most chat hosts: `workspace-core`.
|
|
|
|
`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.
|
|
|
|
Concrete client-specific examples:
|
|
|
|
- Claude Desktop: [examples/claude_desktop_mcp_config.json](claude_desktop_mcp_config.json)
|
|
- Cursor: [examples/cursor_mcp_config.json](cursor_mcp_config.json)
|