Skip to content

docs: surface MCP, Agent Skill and npm CLI in the public product facts - #47

Merged
AnxForever merged 2 commits into
mainfrom
docs/repo-metadata-align
Sep 23, 2026
Merged

AnxForever merged 2 commits into
mainfrom
docs/repo-metadata-align

Conversation

@AnxForever

@AnxForever AnxForever commented Sep 23, 2026

Copy link
Copy Markdown
Owner

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.mdProduct Purpose now 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.md did 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.3 and AnxForever/stylekit-skill are all live.

Change Type

  • docs — documentation only

Scope

  • Documentation

Style Contribution Checklist

Not applicable — this PR adds no style.

Validation

  • pnpm run security:secrets — OK, no obvious secrets in tracked files
  • pnpm run lint — EXIT 0 (38 pre-existing warnings, 0 errors)
  • npx tsc --noEmit — not green locally; see Notes. Cause is a stale .next artifact, not this diff.
  • pnpm test — not run
  • pnpm build — not run

Also run: npx tsx tools/scripts/check-seo-truth.tsPASS, 1140 sitemap URLs and discovery claims satisfy the SEO truth invariants. README.md and README.en.md are both listed in PUBLIC_SEO_SOURCES, so this change sits inside that guard's scope and was re-checked after editing.

Security

  • No secrets, credentials, or .env files committed
  • Server-side values are not exposed via NEXT_PUBLIC_

Breaking Changes

  • None

Screenshots

No UI change. The README's first screen gains a single line — 支持 MCP、Agent Skill 与 npm CLI。 and Available over MCP, as an Agent Skill, and via npm CLI. Best reviewed in this branch's rendered file view.

Notes for Reviewers

  • tsc is red locally, and it is not this change. With 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.ts importing app/api/search/route.js. That route exists on feat/mcp-hybrid-search (PR feat(search): serve hybrid retrieval to MCP style search #46) but not on main, 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.
  • Two related items are deliberately not in this diff. The repository's topics (trimmed from 20 to 8) and its description (now bilingual) live in GitHub repository settings rather than in git. They were applied directly and are already live.
  • PRODUCT.md is not listed in PUBLIC_SEO_SOURCES, so check:seo-truth cannot catch drift in it. This update was made by hand and relies on reviewers keeping it honest.

Summary by CodeRabbit

  • Documentation
    • Updated the product description and README files to note that the style catalog is available through the website, MCP, an Agent Skill, and npm.

@coderabbitai

coderabbitai Bot commented Sep 23, 2026

Copy link
Copy Markdown

Review in Change Stack →

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 116970aa-bab2-4672-8690-77110682e358

📥 Commits

Reviewing files that changed from the base of the PR and between 87440ba and aca0b91.

📒 Files selected for processing (3)
  • PRODUCT.md
  • README.en.md
  • README.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The 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.

Changes

Catalog distribution documentation

Layer / File(s) Summary
Product purpose and README wording
PRODUCT.md, README.en.md, README.md
The product purpose names the catalog's delivery surfaces and calls for consistent catalog facts. Both README taglines list MCP, an Agent Skill, and the npm CLI.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to aca0b

The updated pages describe available catalog surfaces; no material issue remains that should block merging.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: exposing MCP, Agent Skill, and npm CLI as public product surfaces.
Description check ✅ Passed The description follows the repository template and explains the changes, rationale, scope, validation results, security status, breaking changes, screenshots, and reviewer notes. It clearly identifie…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AnxForever
AnxForever merged commit 87fcf45 into main Sep 23, 2026
8 of 9 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