Skip to content

docs(readme): rewrite root README to be MCP-prominent and listing-rich#40

Merged
Declade merged 1 commit into
mainfrom
feat/root-readme-mcp-prominent
May 6, 2026
Merged

docs(readme): rewrite root README to be MCP-prominent and listing-rich#40
Declade merged 1 commit into
mainfrom
feat/root-readme-mcp-prominent

Conversation

@Declade
Copy link
Copy Markdown
Owner

@Declade Declade commented May 6, 2026

Why

The old root README was a 1099-byte monorepo stub that just listed 4 packages and pointed at per-language READMEs. This makes:

  • the mcp.so Overview tab effectively empty (mcp.so scrapes the root README)
  • the Glama Overview block thin
  • the pending awesome-mcp-servers PR #5905 hard for reviewers to assess
  • direct GitHub visitors land on a stub that doesn't actually sell what Lucairn does

What

Single-file diff: README.md only.

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

  • Brand: Lucairn (one c); zero "The Veil" / dsaveil.io / veil_live_* / @dsaveil/... mentions.
  • Tier names: Developer / Pro / Enterprise only — no Pro+ / pro_plus / Solo Free / Solo Pro.
  • Sub-processor mentions stay inside the locked allowlist (no Ollama, no Qwen).
  • Mechanism allowlist respected: no TLS version claims, no SOC 2, no ISO 27001, no HIPAA, no "red team", no uptime SLAs.
  • Custom-trained PII shield is framed Enterprise-only.
  • "no raw identity data leaves your environment" is scoped to Enterprise self-host only; Developer hosted is "on-gateway pseudonymization before your LLM sees the request."

Drift caught + fixed

  • The mcp-server row in the package-identifier table said 1.0.0; the package is actually published at 1.1.0 (CLAUDE.md notes 1.0.1 was published 2026-05-04, and the source mcp-server/package.json is now at 1.1.0 per the Stage 4 cross-provider BYOK ship). Bumped the table accordingly.
  • Cross-provider BYOK now explicitly attributed to @lucairn/mcp-server@1.1.0.

Banned-literal sweep

rg -n 'dsaveil\.io|veil_live_|@dsaveil/|"The Veil"|tracevault_app|Pro\+|pro_plus|Solo Free|Solo Pro|Ollama|Qwen|TLS 1\.[0-9]|E2E encryption|SOC ?2|ISO ?27001|HIPAA|PCI-DSS|red team' README.md

Returns zero matches.

Files touched

  • README.md (123 line diff: +105 / -18; final ~120 lines)

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).
@Declade Declade merged commit b338599 into main May 6, 2026
10 checks passed
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.

1 participant