docs(mcp): document the introduction path — "Walk me through Leadbay" (EN + FR) - #23
Merged
Merged
Conversation
The MCP server ships a guided first-run walkthrough, and the docs had never heard of it. The Quickstart told a brand-new user to type "show me today's leads" — while the walkthrough itself links back to that same Quickstart at both of its endings, as the setup guide it deliberately cannot replace. - Quickstart: an unnumbered section right after sign-in, with the four steps and what each one does. Unnumbered because the tour is optional, and so Steps 3-5 keep their numbers. - Example prompts: a "First time here" section above "Start your day" — the page was ordered by workflow-day and opened mid-journey. - Tools reference: the leadbay_getting_started row and its routing entry. Both spend claims are the shipped behaviour, not a paraphrase: gate 3 drafts with leadId alone and never enriches, and gate 4's free preview runs before any confirmation. Pinned by packages/mcp/test/audit/getting-started-walkthrough.test.ts in the mcp repo. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Section-for-section, so the fr/ tree stays the 1:1 mirror it is — PR #21 exists because that parity slipped once already. The prompt phrasings are French rather than transliterated English: the walkthrough's triggers are matched by the model, not string-compared, and the prompt tells the agent to answer in the user's own language. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Closes leadbay/product#3962
The MCP server ships a guided first-run walkthrough (
leadbay_getting_started, triggered by "Walk me through Leadbay.") and the user docs had never mentioned it. A grep of this repo for "Walk me through" returned nothing.The gap was two-sided: a new user reading the Quickstart is told to type "Show me today's leads" and never learns the guided path exists — while the walkthrough itself links back to
docs.leadbay.app/doc/leadbay-mcp/quickstartat both of its endings, as the setup guide it deliberately cannot replace.What changed
leadbay-mcp/quickstart.mdleadbay-mcp/example-prompts.md## First time heresection above## Start your dayleadbay-mcp/tools-reference.mdleadbay_getting_startedrow + a routing-table entryfr/leadbay-mcp/*The Quickstart section is unnumbered on purpose — the tour is recommended but optional, and this keeps Steps 3–5 (and their FR mirrors) from needing renumbering.
Accuracy
The gate labels come from the manifest verbatim (
packages/core/src/composite/getting-started.ts), and both spend claims are the shipped behaviour rather than a paraphrase: gate 3 drafts withleadIdalone and never enriches; gate 4 runs its freemode:"discover"preview before any confirmation, and the paid reveal costs one credit per contact. All of it is pinned bypackages/mcp/test/audit/getting-started-walkthrough.test.ts— 29 tests green locally across that file andfirst-run-routing.test.ts.Deliberately not documented: the CRM-push and recurring-schedule steps (they were gates 5 and 6, removed in
e4a8280on 2026-08-10), and anything about the email being sent — the walkthrough drafts and stops.mcp-v0.28.0, 2026-08-03mcp-v0.28.0has noleadbay_getting_started.md.tmplA user on the live connector who types "Walk me through Leadbay" today gets nothing; the prompt isn't registered.
mcp'sCHANGELOG.mdalso files the walkthrough under## 0.28.0— a version already published without it — so a version bump is needed before the release is cut.This stays draft until a release carrying the walkthrough ships.
Follow-ups (separate, in
leadbay/mcp)packages/mcp/src/server.ts:165says "five-gate";packages/core/src/index.ts:311-313says "six-gate … → CRM → schedule". Both describe a shape removed on 2026-08-10.README.md:156omitsleadbay_getting_startedfrom the skills list, and its tool table has no row for it.<figure>placeholder (the convention already used inwhat-is-leadbay-mcp.md) ready formcp-walkthrough-gate1.png.