{
  "markdown": "<p align=\"center\">\n  <img alt=\"Starwind UI MCP Server\" src=\"https://shieldcn.dev/header/gradient.svg?title=Starwind+UI+MCP+Server&amp;subtitle=Provide+AI+all+the+tools+it+needs+to+work+with+Starwind+UI&amp;mode=dark\" />\n</p>\n\n<p align=\"center\">\n  <a href=\"https://www.npmjs.com/package/@starwind-ui/mcp\"><img alt=\"npm\" src=\"https://shieldcn.dev/npm/@starwind-ui/mcp.svg\" /></a>\n  <a href=\"https://github.com/starwind-ui/starwind-ui-mcp\"><img alt=\"GitHub stars\" src=\"https://shieldcn.dev/github/starwind-ui/starwind-ui-mcp/stars.svg\" /></a>\n</p>\n\n<p align=\"center\">\n  <a href=\"https://registry.modelcontextprotocol.io/?q=io.github.starwind-ui%2Fmcp\">Official MCP Registry</a>\n  ·\n  <code>io.github.starwind-ui/mcp</code>\n</p>\n\nA TypeScript Model Context Protocol server for [Starwind UI v3](https://starwind.dev/) and [Starwind Pro](https://pro.starwind.dev/). It gives AI clients current, framework-aware guidance for Astro and React projects.\n\n## Quick start\n\nFor the maintained client setup guide, see the [Starwind UI MCP documentation](https://starwind.dev/docs/getting-started/mcp/).\n\nCodex (`~/.codex/config.toml`):\n\n```toml\n[mcp_servers.starwind_ui]\ncommand = \"npx\"\nargs = [\"-y\", \"@starwind-ui/mcp\"]\nenabled = true\n```\n\nClaude Code (`.mcp.json`) or Cursor (`.cursor/mcp.json`):\n\n```json\n{\n  \"mcpServers\": {\n    \"starwind-ui\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@starwind-ui/mcp\"]\n    }\n  }\n}\n```\n\nRestart the client or reload its MCP servers after changing the configuration.\n\n## v3 model\n\nStarwind UI v3 has three related surfaces. The MCP keeps them distinct:\n\n| Surface | What it represents | MCP behavior |\n| --- | --- | --- |\n| Styled components | Copy-owned UI components with Astro and/or React implementations | Search and install with `starwind_search` and `starwind_add` |\n| Primitives | Lower-level Astro and React adapters, backed by Starwind Runtime where applicable | Search with `surface: \"primitive\"`; install with the v3 `primitives add` command |\n| Runtime | Framework-neutral behavior APIs | Fetch with `starwind_docs` using the Runtime topic or surface |\n\nThe server validates these layers against the versioned [`ai-manifest.json`](https://starwind.dev/ai-manifest.json), caches validated data, and falls back to a bundled v3 snapshot if the site is unavailable.\n\n## Tools\n\n| Tool | Purpose |\n| --- | --- |\n| `starwind_init` | Generate v3 initialization commands for an existing Astro or React project. Pro is opt-in. |\n| `starwind_add` | Validate requests and generate installation or deferred-install commands for styled components, primitives, or Astro-only Pro blocks. |\n| `starwind_search` | Search styled components, primitives, and Pro blocks with framework metadata and filters. |\n| `starwind_docs` | Resolve exact component, primitive, Runtime, migration, and framework documentation. |\n| `starwind_migrate` | Inspect a project and generate safe, interactive-first v2-to-v3 migration guidance. |\n\nTool calls return both readable JSON text and MCP `structuredContent`.\n\n## Requirements and behavior\n\n- Generated v3 CLI commands require Node.js 22.12.0 or newer.\n- `starwind_init` targets existing Astro 5+ or React 18+ projects and lets the CLI auto-detect the framework unless `framework` is supplied.\n- Free `@starwind-pro/*` catalog blocks work after ordinary initialization. Paid blocks require explicit authorization; pass `pro: true` only when it is required.\n- Starwind Pro blocks currently target Astro. React searches omit them, and React add requests reject them explicitly.\n- Migration is interactive by default. Set `yes: true` only when backup-and-overwrite behavior is intended.\n- Package-manager and project context are detected locally when possible, and add commands pass the resolved package manager to the CLI. No tool executes the generated command.\n\n## Upgrading from free to Pro\n\nThe MCP keeps Pro discoverable without forcing paid setup. Search results link to the Pro catalog, free Pro blocks remain directly installable, and paid results include a structured `proUpgrade` path with purchase and installation links.\n\nFor an existing Astro project, the MCP recommends:\n\n```bash\npnpm dlx starwind@latest setup --yes\n```\n\nThe setup command auto-detects the project's package manager, so it does not need a `--package-manager` flag. It prepares the Pro registry and `.env.local`; replace the `STARWIND_LICENSE_KEY` placeholder with the purchased key, then run the returned `deferredCommand`. Treat the key as sensitive: keep `.env.local` out of source control and never expose the key in logs or client-side code. A project initialized with `pro: true` receives the equivalent `init --pro` command instead.\n\n## Development\n\n```bash\npnpm build\npnpm lint\npnpm test:run\n```\n\nRun the opt-in production manifest contract test with:\n\n```bash\nRUN_LIVE_CONTRACT_TESTS=1 pnpm test:run src/utils/starwind_live_contract.test.ts\n```\n\n## License\n\nMIT. See `LICENSE`.\n\n## Security\n\n[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/starwind-ui-starwind-ui-mcp-badge.png)](https://mseep.ai/app/starwind-ui-starwind-ui-mcp)\n",
  "bytes": 5087,
  "sha": "9b5ef75fdb65f0b135cd5862394584b005c7a3e96147b9b96b9f92062475a409",
  "repo_slug": "starwind-ui/starwind-ui-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_starwind_ui_mcp_0ec225f6/readme"
}