Skip to content

docs: inform users that updating OpenChrome does not migrate MCP host configs #1489

@shaun0927

Description

@shaun0927

Goal

Make the post-update action for safe parallel MCP sessions explicit to users: installing a new openchrome-mcp version can add broker / auto-elect capabilities, but it does not rewrite existing Claude Code, Codex CLI, OpenCode, or other MCP host registrations. Users must run the relevant setup/config command and restart their host session before the new topology is active.

Final Implementation Scope

Success Criteria

Verification Method

Guardrails

  • Do not silently rewrite user host configs from package install hooks.
  • Do not add postinstall behavior that edits Claude, Codex, OpenCode, or global MCP config files.
  • Do not encourage unsafe shared direct-controller attachment as a normal path.
  • Do not claim that existing active sessions can load a newly configured MCP namespace without restart.
  • Do not collapse distinct topologies: direct isolated profiles, explicit broker, and future auto-elect should remain visibly separate.

Explicit Non-Goals

  • No implementation of auto-elect itself in this issue.
  • No CLI behavior change unless a separate follow-up PR deliberately updates openchrome setup, openchrome doctor, or duplicate-controller remediation.
  • No npm lifecycle script that mutates host configuration.
  • No promise that every third-party MCP host supports the same setup command.
  • No replacement of the explicit broker topology docs.

Implementation Approach

  1. Add a concise README note near installation / setup explaining: update installs capabilities; setup activates them in host config; restart is required.
  2. Add a troubleshooting/action-required note near the parallel sessions section.
  3. Update docs/mcp/topologies.md with a dedicated "After upgrading" subsection for users who expect the npm update alone to fix duplicate-controller failures.
  4. Optionally add release-note wording for the next release once Parallel multi-session is blocked by design — land the #1474 self-healing stack + make the opt-in broker path reachable (SSOT #1359 / audit #1457 alignment) #1480 lands.
  5. Keep the wording future-proof by describing the current explicit broker path and the future/opt-in auto-elect path without assuming default behavior.

PR Decomposition

Over-Engineering Checklist

  • Is this solved with documentation before adding CLI automation? Yes, start with docs.
  • Are we adding a config migration daemon? No.
  • Are we editing user files from npm install? No.
  • Are we adding host-specific hidden behavior? No.
  • Are we creating a new topology? No, only documenting activation of existing / in-flight topologies.

Drift-Prevention Checklist

Language Boundary

  • Primary issue and PR text should be English.
  • README English should carry the canonical wording.
  • README.ko may provide a Korean translation, but it must not introduce different semantics.
  • CLI/user-facing diagnostics should prefer short English text unless a localized surface is explicitly added.

Critical Risk Review

  • Risk: users believe npm update alone fixes existing sessions. Mitigation: state package update vs host config update explicitly.
  • Risk: users expect active sessions to hot-load MCP changes. Mitigation: state host restart is required.
  • Risk: docs imply --auto-elect is stable/default before the PR stack lands. Mitigation: phrase as opt-in / after the feature is available.
  • Risk: users copy unsafe direct shared config. Mitigation: prefer isolated profiles or broker/auto-elect; discourage multiple direct controllers for one profile.
  • Risk: host-specific instructions drift. Mitigation: centralize topology explanation and link setup examples back to it.

Definition of Done

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhost-integrationWires module cores into host (CDP, MCP, tools, transports, OS APIs)reliabilityReliability and stability improvement

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions