docs: surface MCP, Agent Skill and npm CLI in the public product facts - #47
Conversation
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (3)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe product purpose and README taglines now name MCP, an Agent Skill, and npm as catalog delivery surfaces. The product purpose also requires consistent catalog facts across those surfaces. ChangesCatalog distribution documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to The updated pages describe available catalog surfaces; no material issue remains that should block merging. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
What changed:
README.md/README.en.md— the first-screen positioning line now names the three ways the catalog is consumed (MCP, Agent Skill, npm CLI), instead of leaving that information to line 88 of the body.PRODUCT.md—Product Purposenow states that the same catalog is delivered through the website, an MCP server, an Agent Skill, and npm packages, and that the same facts must hold on each surface.Why:
The repository's public facts had drifted apart. Topics and the repository description were aligned with the MCP / Agent Skill / npm ecosystem, but the README's first screen still described the catalog purely as a website, and
PRODUCT.mddid not mention delivery surfaces at all. This makes the same claim everywhere a reader or a tool looks.Every claim was verified before it was written:
stylekit-mcp@0.2.5,stylekit-cli@0.1.4,stylekit@0.2.3andAnxForever/stylekit-skillare all live.Change Type
docs— documentation onlyScope
Style Contribution Checklist
Not applicable — this PR adds no style.
Validation
pnpm run security:secrets— OK, no obvious secrets in tracked filespnpm run lint— EXIT 0 (38 pre-existing warnings, 0 errors)npx tsc --noEmit— not green locally; see Notes. Cause is a stale.nextartifact, not this diff.pnpm test— not runpnpm build— not runAlso run:
npx tsx tools/scripts/check-seo-truth.ts— PASS, 1140 sitemap URLs and discovery claims satisfy the SEO truth invariants.README.mdandREADME.en.mdare both listed inPUBLIC_SEO_SOURCES, so this change sits inside that guard's scope and was re-checked after editing.Security
.envfiles committedNEXT_PUBLIC_Breaking Changes
Screenshots
No UI change. The README's first screen gains a single line —
支持 MCP、Agent Skill 与 npm CLI。andAvailable over MCP, as an Agent Skill, and via npm CLI.Best reviewed in this branch's rendered file view.Notes for Reviewers
NODE_OPTIONS=--max-old-space-size=6144(the default 2096MB heap OOMs at this repo's size, in the type-check phase rather than on a type error), the only remaining error is.next/types/validator.tsimportingapp/api/search/route.js. That route exists onfeat/mcp-hybrid-search(PR feat(search): serve hybrid retrieval to MCP style search #46) but not onmain, and that validator is a stale build artifact left over from working on that branch. A clean checkout will not reproduce it; CI is the real answer.PRODUCT.mdis not listed inPUBLIC_SEO_SOURCES, socheck:seo-truthcannot catch drift in it. This update was made by hand and relies on reviewers keeping it honest.Summary by CodeRabbit