Skip to content

docs: add MCP guide and make the registry ready for the shadcn MCP - #18

Merged
Arifulislam5577 merged 1 commit into
mainfrom
docs/shadcn-mcp
Sep 28, 2026
Merged

Arifulislam5577 merged 1 commit into
mainfrom
docs/shadcn-mcp

Conversation

@moshiur01

Copy link
Copy Markdown
Contributor

What

  • New MCP docs page at /installation/mcp: how to use Tween UI with the shadcn MCP server. Covers registry setup, mcp init for each editor, example prompts, the available tools and troubleshooting.
  • The registry build now emits a <name>-demo example item for every component and block, taken from the Usage section of its docs page. get_item_examples_from_registries now returns real usage code.
  • Every item now ships a docs note, which the CLI prints after install: a link to its page, the GSAP plugins it registers itself, and a reminder when it loads sample images.
  • Six descriptions now include the plain words people search for: login, text animation, image gallery, stats, call-to-action.
  • Fixed 39 stale imports on 27 docs pages that pointed at old category folders (e.g. @/components/tweenui/modal/auth-modal → @/components/tweenui/auth-modal).

Why

The shadcn MCP only sees an item’s name, title, description, files and dependencies, so those fields decide how well an agent finds and uses a block. The registry had no example code, and the Usage snippets on many pages had broken imports if copied.

Notes for review

  • registry.json goes from 41 to 82 items; the 41 new ones are registry:example items, the same pattern the shadcn registry uses.
  • New tests: every docs page imports its item from the install path, and every item has a generated example.
  • Verified with typecheck, tests (749 passing) and next build. Search results were checked with shadcn’s own search function against the built registry

@vercel

vercel Bot commented Sep 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
tween-ui Ready Ready Preview Sep 28, 2026 6:11am UTC

@Arifulislam5577
Arifulislam5577 merged commit b2c944a into main Sep 28, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
Preview — 3fbb91c1 Deployed Sep 28, 2026 by vercel[bot]
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.

2 participants