docs: add MCP guide and make the registry ready for the shadcn MCP - #18
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
What
/installation/mcp: how to use Tween UI with the shadcn MCP server. Covers registry setup,mcp initfor each editor, example prompts, the available tools and troubleshooting.<name>-demoexample item for every component and block, taken from the Usage section of its docs page.get_item_examples_from_registriesnow returns real usage code.docsnote, 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.@/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.jsongoes from 41 to 82 items; the 41 new ones areregistry:exampleitems, the same pattern the shadcn registry uses.next build. Search results were checked with shadcn’s own search function against the built registry