@ringpublishing/mui-components-mcp 2.0.0 → 2.0.2-alpha.1
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/CHANGELOG.md +13 -0
- package/README.md +9 -5
- package/dist/data/knowledge.json +2 -1
- package/dist/index.js +12 -5
- package/dist/index.js.map +1 -1
- package/dist/types.d.ts +1 -1
- package/package.json +1 -3
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CHANGELOG
|
|
2
|
+
|
|
3
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/).
|
|
4
|
+
|
|
5
|
+
## [2.0.2] - 2026-11-02
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- [@rmusial2]: `list_components` returns `libraryVersion`, the `@ringpublishing/mui-components` release the knowledge base was generated from, next to `serverVersion`; the server's instructions name that release too.
|
|
10
|
+
|
|
11
|
+
### Changed
|
|
12
|
+
|
|
13
|
+
- [@rmusial2]: The MCP server has its own version and CHANGELOG; a release of `@ringpublishing/mui-components` or a change in the Storybook stories is a new MCP server version too. Changes up to 2.0.1 are listed in the CHANGELOG of `@ringpublishing/mui-components`.
|
package/README.md
CHANGED
|
@@ -21,16 +21,20 @@ Add to your MCP config:
|
|
|
21
21
|
|
|
22
22
|
| Tool | Description |
|
|
23
23
|
| ----------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
24
|
-
| `list_components` | List all components with name, description, story names, and argTypes count
|
|
24
|
+
| `list_components` | List all components with name, description, story names, and argTypes count, and the library release the knowledge base was generated from |
|
|
25
25
|
| `get_component_details` | Structured component data: description, argTypes (with type, default, options), and story names |
|
|
26
26
|
| `get_component_docs` | Full prose documentation for a component: usage guidelines, behavior descriptions, and code examples |
|
|
27
27
|
|
|
28
|
+
## Versions
|
|
29
|
+
|
|
30
|
+
The server is released on its own schedule, so its version is not the version of `@ringpublishing/mui-components`. `list_components` returns `libraryVersion`, the library release the knowledge base was generated from, next to `serverVersion`; the server's instructions name that release too. Compare `libraryVersion` with the release installed in your project: props and defaults can differ between releases. Every entry in `CHANGELOG.md` names the library release it was generated from.
|
|
31
|
+
|
|
28
32
|
## Data pipeline
|
|
29
33
|
|
|
30
|
-
Knowledge is generated from Storybook source files (MDX + stories) by `scripts/generate-knowledge.ts`.
|
|
34
|
+
Knowledge is generated from Storybook source files (MDX + stories) by `scripts/generate-knowledge.ts`; `libraryVersion` is the top released section of `packages/components/CHANGELOG.md`.
|
|
31
35
|
|
|
32
36
|
```
|
|
33
|
-
stories/**/*.mdx + stories/**/*.stories.tsx
|
|
37
|
+
packages/storybook/stories/**/*.mdx + packages/storybook/stories/**/*.stories.tsx
|
|
34
38
|
↓ generate-knowledge.ts (tsc → dist-scripts/generate-knowledge.js)
|
|
35
39
|
dist/data/knowledge.json
|
|
36
40
|
↓ index.ts (MCP server)
|
|
@@ -41,9 +45,9 @@ stories/**/*.mdx + stories/**/*.stories.tsx
|
|
|
41
45
|
|
|
42
46
|
| Script | Description |
|
|
43
47
|
| ---------------------------- | -------------------------------------------------------------------------------------- |
|
|
44
|
-
| `npm run build` |
|
|
48
|
+
| `npm run build` | Regenerate `dist/data/knowledge.json` (prebuild) and compile TypeScript |
|
|
45
49
|
| `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`
|
|
50
|
+
| `npm run generate-knowledge` | Compile and run the generator, then regenerate `dist/data/knowledge.json` |
|
|
47
51
|
| `npm run dev` | Watch mode for TypeScript compilation |
|
|
48
52
|
| `npm run start` | Run the MCP server |
|
|
49
53
|
|
package/dist/data/knowledge.json
CHANGED
package/dist/index.js
CHANGED
|
@@ -14,15 +14,15 @@ const SERVER_VERSION = (_a = packageJson.version) !== null && _a !== void 0 ? _a
|
|
|
14
14
|
const knowledge = loadKnowledge();
|
|
15
15
|
const components = Object.values(knowledge.components);
|
|
16
16
|
function loadKnowledge() {
|
|
17
|
-
var _a, _b
|
|
17
|
+
var _a, _b;
|
|
18
18
|
const fileContent = readFileSync(KNOWLEDGE_PATH, 'utf8');
|
|
19
19
|
const parsed = JSON.parse(fileContent);
|
|
20
20
|
const normalizedComponents = (_a = parsed.components) !== null && _a !== void 0 ? _a : {};
|
|
21
21
|
return {
|
|
22
22
|
generated: parsed.generated || new Date().toISOString(),
|
|
23
|
-
|
|
23
|
+
libraryVersion: parsed.libraryVersion,
|
|
24
24
|
importPath: parsed.importPath || '@ringpublishing/mui-components',
|
|
25
|
-
componentCount: (
|
|
25
|
+
componentCount: (_b = parsed.componentCount) !== null && _b !== void 0 ? _b : Object.keys(normalizedComponents).length,
|
|
26
26
|
components: normalizedComponents,
|
|
27
27
|
};
|
|
28
28
|
}
|
|
@@ -74,9 +74,15 @@ function findComponent(query) {
|
|
|
74
74
|
const mcpServer = new McpServer({
|
|
75
75
|
name: 'mui-components-mcp',
|
|
76
76
|
version: SERVER_VERSION,
|
|
77
|
+
}, {
|
|
78
|
+
instructions: `Documentation of ${knowledge.importPath} ${knowledge.libraryVersion}, generated from its Storybook.` +
|
|
79
|
+
' The server has a version of its own; a project may have another release of the library installed' +
|
|
80
|
+
' (node_modules/@ringpublishing/mui-components/package.json), where props and defaults can differ.',
|
|
77
81
|
});
|
|
78
82
|
mcpServer.registerTool('list_components', {
|
|
79
|
-
description: 'List all available Ring Publishing MUI components with names and short descriptions.'
|
|
83
|
+
description: 'List all available Ring Publishing MUI components with names and short descriptions.' +
|
|
84
|
+
' The result names the library release the documentation describes (libraryVersion)' +
|
|
85
|
+
' and the version of this server (serverVersion).',
|
|
80
86
|
}, () => {
|
|
81
87
|
const allComponents = components.map((component) => summarizeComponent(component));
|
|
82
88
|
return {
|
|
@@ -85,7 +91,8 @@ mcpServer.registerTool('list_components', {
|
|
|
85
91
|
type: 'text',
|
|
86
92
|
text: JSON.stringify({
|
|
87
93
|
total: allComponents.length,
|
|
88
|
-
|
|
94
|
+
libraryVersion: knowledge.libraryVersion,
|
|
95
|
+
serverVersion: SERVER_VERSION,
|
|
89
96
|
importPath: knowledge.importPath,
|
|
90
97
|
components: allComponents,
|
|
91
98
|
}, null, 2),
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;AAC/D,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AAE9D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAyB,CAAC;AAChG,MAAM,cAAc,GAAG,MAAA,WAAW,CAAC,OAAO,mCAAI,KAAK,CAAC;AAEpD,MAAM,SAAS,GAAG,aAAa,EAAE,CAAC;AAClC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;AAEvD,SAAS,aAAa;;IAClB,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAc,CAAC;IACpD,MAAM,oBAAoB,GAAG,MAAA,MAAM,CAAC,UAAU,mCAAI,EAAE,CAAC;IAErD,OAAO;QACH,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACvD,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;AAC/D,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AAE9D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAyB,CAAC;AAChG,MAAM,cAAc,GAAG,MAAA,WAAW,CAAC,OAAO,mCAAI,KAAK,CAAC;AAEpD,MAAM,SAAS,GAAG,aAAa,EAAE,CAAC;AAClC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;AAEvD,SAAS,aAAa;;IAClB,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAc,CAAC;IACpD,MAAM,oBAAoB,GAAG,MAAA,MAAM,CAAC,UAAU,mCAAI,EAAE,CAAC;IAErD,OAAO;QACH,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACvD,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,gCAAgC;QACjE,cAAc,EAAE,MAAA,MAAM,CAAC,cAAc,mCAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,MAAM;QACjF,UAAU,EAAE,oBAAoB;KACnC,CAAC;AACN,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAoB;IAC5C,OAAO;QACH,EAAE,EAAE,SAAS,CAAC,EAAE;QAChB,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,UAAU,EAAE,SAAS,CAAC,UAAU;QAChC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM;KACxD,CAAC;AACN,CAAC;AAED,SAAS,mBAAmB,CAAC,SAAoB;IAC7C,OAAO;QACH,EAAE,EAAE,SAAS,CAAC,EAAE;QAChB,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,UAAU,EAAE,SAAS,CAAC,UAAU;QAChC,QAAQ,EAAE,SAAS,CAAC,QAAQ;KAC/B,CAAC;AACN,CAAC;AAED,SAAS,gBAAgB,CAAC,SAAoB;IAC1C,OAAO;QACH,EAAE,EAAE,SAAS,CAAC,EAAE;QAChB,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,IAAI,EAAE,SAAS,CAAC,IAAI;KACvB,CAAC;AACN,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAChC,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAErC,IAAI,CAAC,eAAe,EAAE;QAClB,OAAO,IAAI,CAAC;KACf;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAEnD,IAAI,IAAI,EAAE;QACN,OAAO,IAAI,CAAC;KACf;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC;IAElF,IAAI,MAAM,EAAE;QACR,OAAO,MAAM,CAAC;KACjB;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,WAAW,EAAE,CAAC;IACjD,MAAM,qBAAqB,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,CAAC;IAE1G,IAAI,qBAAqB,EAAE;QACvB,OAAO,qBAAqB,CAAC;KAChC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,SAAS,GAAG,IAAI,SAAS,CAC3B;IACI,IAAI,EAAE,oBAAoB;IAC1B,OAAO,EAAE,cAAc;CAC1B,EACD;IACI,YAAY,EACR,oBAAoB,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,cAAc,iCAAiC;QACrG,mGAAmG;QACnG,mGAAmG;CAC1G,CACJ,CAAC;AAEF,SAAS,CAAC,YAAY,CAClB,iBAAiB,EACjB;IACI,WAAW,EACP,sFAAsF;QACtF,oFAAoF;QACpF,kDAAkD;CACzD,EACD,GAAG,EAAE;IACD,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEnF,OAAO;QACH,OAAO,EAAE;YACL;gBACI,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAChB;oBACI,KAAK,EAAE,aAAa,CAAC,MAAM;oBAC3B,cAAc,EAAE,SAAS,CAAC,cAAc;oBACxC,aAAa,EAAE,cAAc;oBAC7B,UAAU,EAAE,SAAS,CAAC,UAAU;oBAChC,UAAU,EAAE,aAAa;iBAC5B,EACD,IAAI,EACJ,CAAC,CACJ;aACJ;SACJ;KACJ,CAAC;AACN,CAAC,CACJ,CAAC;AAEF,SAAS,CAAC,YAAY,CAClB,uBAAuB,EACvB;IACI,WAAW,EACP,uGAAuG;QACvG,oDAAoD;QACpD,kIAAkI;QAClI,wGAAwG;QACxG,iDAAiD;QACjD,qFAAqF;IACzF,WAAW,EAAE;QACT,IAAI,EAAE,CAAC;aACF,MAAM,EAAE;aACR,QAAQ,CAAC,iFAAiF,CAAC;KACnG;CACJ,EACD,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACT,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAEtC,IAAI,CAAC,SAAS,EAAE;QACZ,OAAO;YACH,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,cAAc,IAAI,+DAA+D;iBAC1F;aACJ;SACJ,CAAC;KACL;IAED,OAAO;QACH,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KAC7F,CAAC;AACN,CAAC,CACJ,CAAC;AAEF,SAAS,CAAC,YAAY,CAClB,oBAAoB,EACpB;IACI,WAAW,EACP,oHAAoH;QACpH,0EAA0E;IAC9E,WAAW,EAAE;QACT,IAAI,EAAE,CAAC;aACF,MAAM,EAAE;aACR,QAAQ,CAAC,iFAAiF,CAAC;KACnG;CACJ,EACD,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACT,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAEtC,IAAI,CAAC,SAAS,EAAE;QACZ,OAAO;YACH,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,cAAc,IAAI,+DAA+D;iBAC1F;aACJ;SACJ,CAAC;KACL;IAED,OAAO;QACH,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KAC1F,CAAC;AACN,CAAC,CACJ,CAAC;AAEF,KAAK,UAAU,IAAI;IACf,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;IAC5B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC"}
|
package/dist/types.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
"description": "MCP server for Ring Publishing MUI Components documentation",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "LGPL-3.0-or-later",
|
|
6
|
-
"repository": "ringpublishing/mui-components",
|
|
7
6
|
"homepage": "https://design.ringpublishing.com/?path=/docs/introduction-mcp-server--docs",
|
|
8
7
|
"bin": {
|
|
9
8
|
"mui-components-mcp": "./dist/index.js"
|
|
@@ -14,7 +13,6 @@
|
|
|
14
13
|
"build:scripts": "tsc -p tsconfig.scripts.json",
|
|
15
14
|
"generate-knowledge": "npm run build:scripts && node dist-scripts/scripts/generate-knowledge.js",
|
|
16
15
|
"prebuild": "npm run generate-knowledge",
|
|
17
|
-
"prepare": "npm run build",
|
|
18
16
|
"start": "node dist/index.js"
|
|
19
17
|
},
|
|
20
18
|
"dependencies": {
|
|
@@ -29,5 +27,5 @@
|
|
|
29
27
|
"engines": {
|
|
30
28
|
"node": "^18||^20||^22||^24"
|
|
31
29
|
},
|
|
32
|
-
"version": "2.0.
|
|
30
|
+
"version": "2.0.2-alpha.1"
|
|
33
31
|
}
|