@ringpublishing/mui-components-mcp 1.15.2-alpha.4
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.
- package/README.md +70 -0
- package/data/knowledge.json +3585 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +156 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +44 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/package.json +35 -0
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# @ringpublishing/mui-components-mcp
|
|
2
|
+
|
|
3
|
+
MCP server providing documentation knowledge base for Ring Publishing MUI Components.
|
|
4
|
+
|
|
5
|
+
## Usage in Claude Desktop / Cursor / VS Code / Copilot
|
|
6
|
+
|
|
7
|
+
Add to your MCP config:
|
|
8
|
+
|
|
9
|
+
```json
|
|
10
|
+
{
|
|
11
|
+
"mcpServers": {
|
|
12
|
+
"ring-mui": {
|
|
13
|
+
"command": "npx",
|
|
14
|
+
"args": ["-y", "@ringpublishing/mui-components-mcp"]
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Available tools
|
|
21
|
+
|
|
22
|
+
| Tool | Description |
|
|
23
|
+
| ----------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
24
|
+
| `list_components` | List all components with name, description, story names, and argTypes count |
|
|
25
|
+
| `get_component_details` | Structured component data: description, argTypes (with type, default, options), and story names |
|
|
26
|
+
| `get_component_docs` | Full prose documentation for a component: usage guidelines, behavior descriptions, and code examples |
|
|
27
|
+
|
|
28
|
+
## Data pipeline
|
|
29
|
+
|
|
30
|
+
Knowledge is generated from Storybook source files (MDX + stories) by `scripts/generate-knowledge.ts`.
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
stories/**/*.mdx + stories/**/*.stories.tsx
|
|
34
|
+
↓ generate-knowledge.ts (tsc → dist-scripts/generate-knowledge.js)
|
|
35
|
+
data/knowledge.json
|
|
36
|
+
↓ index.ts (MCP server)
|
|
37
|
+
list_components / get_component_details / get_component_docs
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Scripts
|
|
41
|
+
|
|
42
|
+
| Script | Description |
|
|
43
|
+
| ---------------------------- | -------------------------------------------------------------------------------------- |
|
|
44
|
+
| `npm run build` | Sync version (CI-only no-op outside CI), regenerate knowledge.json, compile TypeScript |
|
|
45
|
+
| `npm run build:scripts` | Compile TypeScript scripts from `scripts/` to `dist-scripts/` |
|
|
46
|
+
| `npm run generate-knowledge` | Compile and run generator, then regenerate `data/knowledge.json` |
|
|
47
|
+
| `npm run dev` | Watch mode for TypeScript compilation |
|
|
48
|
+
| `npm run start` | Run the MCP server |
|
|
49
|
+
|
|
50
|
+
## Testing with MCP Inspector
|
|
51
|
+
|
|
52
|
+
[MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) is a web UI for interacting with MCP servers — useful for verifying tool responses during development.
|
|
53
|
+
|
|
54
|
+
### Local development
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# Build first
|
|
58
|
+
npm run build
|
|
59
|
+
|
|
60
|
+
# Run inspector against local build
|
|
61
|
+
npx @modelcontextprotocol/inspector node dist/index.js
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Inspector opens at `http://localhost:6274`. Use it to call `list_components`, `get_component_details`, and `get_component_docs` and verify responses.
|
|
65
|
+
|
|
66
|
+
### Published package
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx @modelcontextprotocol/inspector npx -y @ringpublishing/mui-components-mcp
|
|
70
|
+
```
|