docs(spec): optional-connector catalog#152
Open
jordanrburger wants to merge 2 commits into
Open
Conversation
Design spec (for review, not yet implemented) for a curated, in-engine catalog of optional connectors users can browse and turn on without authoring — generalizing the one-off "Google Messages connector" need. Approach A (chosen): the roster IS the catalog. Extend connectors.yaml entries (and the Connector loader) with `optional: true` (default-off; never auto-enabled by detection) + a `catalog:` block (summary/description/requirements/setup). Add scoutctl `connectors catalog` (browse) + `enable`/`disable` (guided: config write, needs_user_input collection, setup steps, probe verify, and an additive brain-file re-render so it takes effect). Surface the catalog as an opt-in step in the /scout-setup & /scout-update wizard. Seed with Google Messages (de-personalized; no contacts ship — that's vault-only state). Alternatives B (connector package directories — for community sharing, scoped out) and C (separate catalog manifest — drift) considered and rejected. Companion to specs #149 (merged) and #150. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This was referenced Jun 27, 2026
…model The catalog's enable flow (add key to connectors.enabled → re-render so requires:-gated sections appear) only works if a connector has ONE key across its namespaces: probe/detection, config enabled, phase requires:, and roster. Add a canonical-key invariant section (§7) making agreement a hard, validation-enforced rule, and call out the existing mail-connector violation (#172 — probe/config key `gmail` vs phase `requires: email`, which drops the whole email phase from assembled SKILL.md) as a precondition to reconcile. Recommend standardizing on the provider-neutral key `email` with a `gmail` alias + idempotent `gmail → email` config normalization on /scout-update. Adds a key-consistency test bullet and a legacy-config-migration risk note; renumbers Testing to §8. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Folded #172 (email/
Commit: 8b8ffc2. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Design review only — no behavior change. Adds a design spec; implementation follows once the approach is agreed. Generalizes the one-off "Google Messages connector" into a reusable catalog. Companion to #149 (merged) and #150.
Context
Scout ships a fixed default connector set. Adding anything else (e.g. Google Messages for personal texts) means hand-editing three files (
connectors.yaml,connector-probes.yaml,phases/connectors/*.md) and knowing how assembly gates onenabled_connectors. There's no way for a user to browse connectors Scout already knows how to drive but doesn't enable by default, and turn one on without that authoring.The enable mechanism is largely already there — the gap is discovery, a turn-on flow, and a default-off marker.
Proposed design (Approach A — "the roster is the catalog")
connectors.yamlentries (+ theConnectorloader) withoptional: true(default-off; never auto-enabled by detection) and acatalog:block (summary/description/requirements/setup). Orthogonal totier.scoutctl connectors catalog [--json]lists optional connectors with enabled/available markers.enable <key>writes config, collectsneeds_user_input, prints setup steps, probe-verifies, and re-renders the brain files (additive cat-4 merge → clean) so it takes effect now;/scout-updateis the fallback.disablereverts config./scout-setup&/scout-updatesurface the catalog as an opt-in step (built on the CLI primitive).Alternatives B (connector package dirs — for community sharing, scoped out; sizeable refactor) and C (separate catalog manifest — drift) documented and rejected. B is left as a clean future path.
Asking reviewers
/scout-updateas fallback — comfortable with that, or should enable always defer to/scout-update?Spec:
docs/superpowers/specs/2026-06-21-optional-connector-catalog-design.md🤖 Generated with Claude Code