pyro-mcp/docs/roadmap/llm-chat-ergonomics/3.8.0-chat-host-onramp-and-recommended-defaults.md
Thales Maciel 407c805ce2 Clarify workspace-core as the chat-host onramp
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.
2026-03-13 11:23:51 -03:00

1.6 KiB

3.8.0 Chat-Host Onramp And Recommended Defaults

Status: Done

Goal

Make the recommended chat-host entrypoint obvious before a new integrator has to read deep integration docs.

Public API Changes

No breaking API change is required in this milestone.

The main user-visible change is guidance:

  • pyro mcp serve help text should clearly call workspace-core the recommended chat-host profile
  • README, install docs, first-run docs, and shipped MCP configs should all lead with workspace-core
  • workspace-full should be framed as the explicit advanced/compatibility surface for 3.x

Implementation Boundaries

  • keep the 3.x compatibility default unchanged
  • do not add new profile names
  • make the recommendation visible from help text and top-level docs, not only the integrations page
  • keep provider examples and MCP examples aligned on the same profile story

Non-Goals

  • no breaking default flip to workspace-core in 3.x
  • no new hidden server behavior based on client type
  • no divergence between CLI, SDK, and MCP terminology for the profile ladder

Acceptance Scenarios

  • a new chat-host integrator sees workspace-core as the recommended first MCP profile from the first help/doc pass
  • the top-level docs include one tiny chat-host quickstart near the first-run path
  • shipped config examples and provider examples all align on the same profile progression

Required Repo Updates

  • top-level docs updated with a minimal chat-host quickstart
  • pyro mcp serve --help rewritten to emphasize workspace-core
  • examples and config snippets audited so they all agree on the recommended profile