@nucleux/mcp 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +50 -4
  2. package/dist/index.js +2201 -88
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -4,15 +4,57 @@ Model Context Protocol server for **[Nucleux](https://github.com/intelligaia-ope
4
4
 
5
5
  It ships a catalog generated from the packages themselves, so the answers match the published code — no guessing, no hallucinated props.
6
6
 
7
- ## Run
7
+ ## Quick start
8
8
 
9
- No install needed — run it with `npx`:
9
+ You never install this package by hand — your AI client runs it on demand via `npx`.
10
+
11
+ **Prerequisites:** [Node.js](https://nodejs.org) ≥ 18 (provides `npx`) and an MCP-capable client (Claude Code, Claude Desktop, Cursor, Windsurf, …).
12
+
13
+ **Claude Code** (one command):
14
+
15
+ ```bash
16
+ claude mcp add nucleux -- npx -y @nucleux/mcp
17
+ ```
18
+
19
+ Then verify: `claude mcp list` → `nucleux ✓ connected`.
20
+
21
+ That's it. Now just ask your agent in plain language — it calls the tools for you:
22
+
23
+ > "Set up Nucleux in this project."
24
+ > "What Nucleux components exist for a chat UI?"
25
+ > "Show me the InputBar props and build a composer with a stop button."
26
+ > "Give me a full agent-chat screen using Nucleux."
27
+
28
+ ## Configure other clients
29
+
30
+ **Cursor** — create `.cursor/mcp.json` in your project (or the global config):
31
+
32
+ ```json
33
+ { "mcpServers": { "nucleux": { "command": "npx", "args": ["-y", "@nucleux/mcp"] } } }
34
+ ```
35
+
36
+ **Claude Desktop** — edit `claude_desktop_config.json`, then restart the app:
37
+
38
+ - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
39
+ - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
40
+
41
+ ```json
42
+ { "mcpServers": { "nucleux": { "command": "npx", "args": ["-y", "@nucleux/mcp"] } } }
43
+ ```
44
+
45
+ **Windsurf / other clients** — use the same `command`/`args` in their MCP settings.
46
+
47
+ > **Windows:** if the client can't find `npx`, use `"command": "npx.cmd"`.
48
+
49
+ ## Verify it works
50
+
51
+ Run it directly:
10
52
 
11
53
  ```bash
12
54
  npx -y @nucleux/mcp
13
55
  ```
14
56
 
15
- It speaks MCP over stdio.
57
+ It should print `nucleux-mcp ready — 48 components, 6 examples.` to **stderr**, then wait on stdin — that's correct, it speaks MCP (JSON-RPC) over stdio. Press `Ctrl+C` to exit. If you see that line, your client integration will work.
16
58
 
17
59
  ## Tools
18
60
 
@@ -48,7 +90,11 @@ Add to the client's MCP config (`claude_desktop_config.json`, `.cursor/mcp.json`
48
90
  }
49
91
  ```
50
92
 
51
- Then ask your agent things like *"list the Nucleux chat components"* or *"show me the InputBar props and build a composer"* — it will call these tools and use the exact API.
93
+ ## Typical first-run flow
94
+
95
+ 1. Add the server (Quick start above).
96
+ 2. *"Set up Nucleux in this project"* → the agent runs `get_setup`, installs `@nucleux/react @nucleux/tokens`, and wires the Tailwind preset + CSS import.
97
+ 3. *"Build a settings page with Nucleux"* → it searches, pulls the real props/examples, and writes accurate components.
52
98
 
53
99
  ## License
54
100