docs(readme): rewrite root README to be MCP-prominent and listing-rich#40
Merged
Conversation
The old root README was a 1099-byte stub. mcp.so and Glama scrape this file for their Overview tabs, so a thin root README means thin listings. This rewrite leads with the npx one-liner + MCP client config snippet (highest-leverage discovery path), then explains what Lucairn does in 30s, then provider routing, then the existing per-language SDK index. Tier framing is honest (Developer / Pro / Enterprise), env vars are correct (LUCAIRN_API_KEY preferred, ANTHROPIC_API_KEY/OPENAI_API_KEY BYOK), and the mcp-server table row reflects the actually-published 1.1.0 (was 1.0.0 in the stub — drift caught and corrected).
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.
Why
The old root README was a 1099-byte monorepo stub that just listed 4 packages and pointed at per-language READMEs. This makes:
What
Single-file diff:
README.mdonly.The rewrite leads with the highest-leverage discovery path (the MCP one-liner + JSON config snippet), then explains the 3-layer sanitizer pipeline, then provider routing, then the existing per-language SDK table, then sign-up + verify flow.
Constraints respected
c); zero "The Veil" /dsaveil.io/veil_live_*/@dsaveil/...mentions.Drift caught + fixed
mcp-serverrow in the package-identifier table said1.0.0; the package is actually published at1.1.0(CLAUDE.md notes 1.0.1 was published 2026-05-04, and the sourcemcp-server/package.jsonis now at 1.1.0 per the Stage 4 cross-provider BYOK ship). Bumped the table accordingly.@lucairn/mcp-server@1.1.0.Banned-literal sweep
Returns zero matches.
Files touched
README.md(123 line diff: +105 / -18; final ~120 lines)