Skip to content

docs: say what the toolkit is, and that an account is required - #17

Merged
ArtemKosolap merged 1 commit into
mainfrom
dev/REPLY-51277-where-this-fits
Aug 3, 2026
Merged

docs: say what the toolkit is, and that an account is required#17
ArtemKosolap merged 1 commit into
mainfrom
dev/REPLY-51277-where-this-fits

Conversation

@ArtemKosolap

Copy link
Copy Markdown
Contributor

What

Two additions to the README:

  1. Where this fits — after Staying up to date, before Usage.
  2. An opening to Authentication covering the Reply.io account, and a note that this is open
    source but not self-hosted.

Why

The toolkit was invisible from here. The README mentioned the MCP server zero times and never
explained how the CLI, MCP and the skill packs relate, so the CLI read as the entire product. The
shared block is worded identically in all three repositories — only the row for the current
repo differs, losing its link and gaining (this repo). Three READMEs quietly drifting apart is
what produced the gap; a verbatim block makes the next divergence visible on sight.

Nothing told a reader they need an account. reply auth login was documented as a command,
not as a decision. Someone without a Reply.io account had no way to learn from this README that
the login flow can create one, that the trial costs nothing, or — the one most likely to waste
their afternoon — that execution always runs against Reply.io and there is no local mode. The
CLI, the skills and the local tooling are genuinely free and open source; the account is what
buys mailboxes, sending, the contact store and analytics. Saying so up front is cheaper than
letting someone discover it after installing.

The wording deliberately says free trial rather than free tier: a trial is what exists today,
and promising the other would be a false promise with a two-week fuse.

Verification

  • Where this fits is byte-identical to the block in reply-mcp, excluding the two
    repo-specific rows — diffed, not eyeballed.
  • The self-hosted note names only what is actually forkable. The CLI and the skill packs are MIT
    in public repositories; the MCP server is hosted by us, so it is described as hosted rather
    than as something you could run yourself.
  • README-only change: docs: triggers no release, and no command behaviour is claimed that
    reply --help does not already show.

Two gaps a cold reader walked into. The README never mentioned the MCP
server or how the three pieces relate, so the CLI read as the entire
product. And it said nothing about needing a Reply.io account: someone
without one had no way to learn that `reply auth login` can create one,
or that execution always runs against Reply.io rather than a local mode.

Add the shared three-surface block, worded identically in all three
repositories, and open Authentication with what the account buys and what
this project is not.
@ArtemKosolap
ArtemKosolap merged commit dc4c126 into main Aug 3, 2026
5 checks passed
@ArtemKosolap
ArtemKosolap deleted the dev/REPLY-51277-where-this-fits branch August 3, 2026 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants