Skip to content

Commit 7fa2ba0

Browse files
committed
docs: say what the toolkit is, and that an account is required
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.
1 parent 687117d commit 7fa2ba0

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,22 @@ after a second and a half, and stays silent when it fails. It never runs for any
5555
other command, and never at all with `--json`, when output is piped, in CI, or
5656
with `REPLY_NO_UPDATE_CHECK=1` set.
5757

58+
## Where this fits
59+
60+
Reply's agentic toolkit is three pieces. They are complementary, not alternatives:
61+
62+
| | What it is | When you want it |
63+
|---|---|---|
64+
| **reply CLI** (this repo) | `npm i -g reply-cli` — authenticated access to *every* v3 endpoint via `reply api` | Your agent has a shell. This is the complete surface. |
65+
| **[Reply MCP](https://github.com/reply-team/reply-mcp)** | A curated tool catalog over `mcp.reply.io` | Your client speaks MCP and has no shell — desktop apps, hosted assistants. |
66+
| **[reply-skills](https://github.com/reply-team/reply-skills)** | Outbound expertise as markdown skills: what to do, in what order, with what guardrails | Your agent knows *how* to call things but not *what* to run. |
67+
68+
MCP gives your agent tools. Skills give it judgement. Most setups want both; a shell-capable
69+
agent can do everything through the CLI alone.
70+
71+
The shortest path that works: install the CLI, `reply auth login`, `reply skills install`, then
72+
talk to your agent in plain words. MCP is optional — add it when your client has no shell.
73+
5874
## Usage
5975

6076
```sh
@@ -67,6 +83,16 @@ machine-readable output suitable for scripts.
6783

6884
## Authentication
6985

86+
**You need a Reply.io account.** If you have one, sign in with it. If you don't, `reply auth
87+
login` takes you to the browser, where you can create one and start a free trial — no credit
88+
card. The CLI, the skill packs and the local tooling are free and open source; what a Reply.io
89+
account gives you is the execution: mailboxes, sending, the contact store, the inbox, analytics.
90+
91+
> **Open source, not self-hosted.** The CLI and the skill packs are MIT and yours to fork.
92+
> Execution always runs against Reply.io — the API, the hosted MCP server at `mcp.reply.io`,
93+
> your mailboxes and your data. There is no local mode, and outreach without a Reply.io account
94+
> is not something this toolkit can do.
95+
7096
Log in through your browser with OAuth:
7197

7298
```sh

0 commit comments

Comments
 (0)