@iblai/iblai-js 1.0.26 → 1.0.28

package/README.md

@@ -527,6 +527,88 @@ e2e/
 
 ---
 
+## MCP Server (AI-Assisted Development)
+
+This package includes an MCP (Model Context Protocol) server (`@iblai/mcp`) that provides AI assistants like Claude with authoritative documentation about the IBL packages — components, hooks, API queries, provider setup patterns, and more.
+
+### Usage with Claude Code
+
+**Option 1 — `npx` (no install needed):**
+
+```bash
+claude mcp add --transport stdio iblai-js-mcp -- npx @iblai/mcp
+```
+
+> **pnpm projects:** If your project already has `@iblai/iblai-js` installed, `npx` may detect the transitive `@iblai/mcp` dependency locally but fail to link its binary. Use `pnpm dlx` instead:
+>
+> ```bash
+> claude mcp add --transport stdio iblai-js-mcp -- pnpm dlx @iblai/mcp
+> ```
+
+**Option 2 — after installing `@iblai/iblai-js` globally:**
+
+```bash
+npm install -g @iblai/iblai-js
+claude mcp add --transport stdio iblai-js-mcp -- ibl-mcp-server
+```
+
+**Option 3 — project-level config (shared with team via git):**
+
+Create a `.mcp.json` file at your project root:
+
+```json
+{
+  "mcpServers": {
+    "iblai-js-mcp": {
+      "command": "npx",
+      "args": ["@iblai/mcp"]
+    }
+  }
+}
+```
+
+For pnpm projects where `@iblai/iblai-js` is a dependency:
+
+```json
+{
+  "mcpServers": {
+    "iblai-js-mcp": {
+      "command": "pnpm",
+      "args": ["dlx", "@iblai/mcp"]
+    }
+  }
+}
+```
+
+Claude Code will detect this file and prompt team members to approve the server on first use.
+
+### What the MCP Server Provides
+
+| Category | Tool / Resource | Description |
+| --- | --- | --- |
+| Components | `get_component_info` | Detailed props, usage examples, and category for any UI component |
+| Hooks | `get_hook_info` | Parameters, return types, and examples for React hooks |
+| API Queries | `get_api_query_info` | RTK Query endpoint details and usage patterns |
+| Providers | `get_provider_setup` | Correct provider hierarchy for each app type |
+| Page Templates | `create_page_template` | Generate new pages following IBL patterns |
+| Playwright | `get_playwright_helper_info` | E2E test helper documentation |
+| Guides | `ibl://guides/*` | Layout rules, RBAC patterns, theming, Playwright setup |
+| Package Docs | `ibl://packages/*` | Full package documentation for each subpath |
+
+### Usage with Other MCP Clients
+
+The server uses stdio transport and follows the [MCP specification](https://modelcontextprotocol.io). Any MCP-compatible client can use it:
+
+```bash
+# Run directly
+npx @iblai/mcp
+
+# Or if installed globally via @iblai/iblai-js
+ibl-mcp-server
+```
+
+---
+
 ## Relationship to Standalone Packages
 
 `@iblai/iblai-js` is a convenience wrapper. Each subpath is a direct re-export from its standalone package: