@getflip/swirl-mcp 0.0.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.
- package/README.md +66 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# @getflip/swirl-mcp
|
|
2
|
+
|
|
3
|
+
MCP server that lets AI agents discover and use [Swirl Design System](https://getflip.dev) components.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
### Local (stdio)
|
|
8
|
+
|
|
9
|
+
Add to your MCP settings:
|
|
10
|
+
|
|
11
|
+
```json
|
|
12
|
+
{
|
|
13
|
+
"mcpServers": {
|
|
14
|
+
"swirl": {
|
|
15
|
+
"command": "npx",
|
|
16
|
+
"args": ["-y", "@getflip/swirl-mcp"]
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Remote (HTTP)
|
|
23
|
+
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"mcpServers": {
|
|
27
|
+
"swirl": {
|
|
28
|
+
"url": "https://swirl-mcp.getflip.tech/mcp"
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Local testing
|
|
35
|
+
|
|
36
|
+
### stdio
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npx @modelcontextprotocol/inspector node dist/transports/stdio.js
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### HTTP
|
|
43
|
+
|
|
44
|
+
Start the server, then open the Inspector and connect with transport type "Streamable HTTP" and URL `http://localhost:3000/mcp`:
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
npx tsx src/transports/http.ts
|
|
48
|
+
npx @modelcontextprotocol/inspector
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Tools
|
|
52
|
+
|
|
53
|
+
| Tool | Description |
|
|
54
|
+
| ------------------------- | ---------------------------------------------------------------------------- |
|
|
55
|
+
| **list_components** | Lists all Swirl UI components with brief summaries and related components. |
|
|
56
|
+
| **list_icons** | Lists all Swirl icon components. |
|
|
57
|
+
| **list_symbols** | Lists all Swirl symbol components. |
|
|
58
|
+
| **list_emojis** | Lists all Swirl emoji components. |
|
|
59
|
+
| **get_component_details** | Full component docs: props, events, slots, examples, and accessibility info. |
|
|
60
|
+
| **get_started** | Installation and setup guide for Web Components, Angular, and React. |
|
|
61
|
+
|
|
62
|
+
All tools accept a `version` parameter matching the installed `@getflip/swirl-components` version.
|
|
63
|
+
|
|
64
|
+
## How it works
|
|
65
|
+
|
|
66
|
+
Component metadata and documentation are fetched at runtime from `@getflip/swirl-ai` artifacts on the unpkg CDN. Loaded libraries are cached in-memory to avoid redundant fetches.
|
package/package.json
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@getflip/swirl-mcp",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "MCP server for Swirl Design System — lets AI agents discover and use Swirl components",
|
|
5
|
+
"author": "Flip GmbH",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/getflip/swirl"
|
|
9
|
+
},
|
|
10
|
+
"license": "SEE LICENSE IN LICENSE.md",
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/getflip/swirl/issues"
|
|
13
|
+
},
|
|
14
|
+
"type": "module",
|
|
15
|
+
"bin": {
|
|
16
|
+
"swirl-mcp": "dist/transports/stdio.js"
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"README.md"
|
|
21
|
+
],
|
|
22
|
+
"scripts": {
|
|
23
|
+
"build": "tsup",
|
|
24
|
+
"start": "node dist/transports/http.js",
|
|
25
|
+
"dev": "tsx src/transports/stdio.ts",
|
|
26
|
+
"dev:server": "tsx src/transports/http.ts",
|
|
27
|
+
"lint": "tsc --noEmit"
|
|
28
|
+
},
|
|
29
|
+
"tsup": {
|
|
30
|
+
"entry": {
|
|
31
|
+
"transports/stdio": "src/transports/stdio.ts",
|
|
32
|
+
"transports/http": "src/transports/http.ts"
|
|
33
|
+
},
|
|
34
|
+
"format": [
|
|
35
|
+
"esm"
|
|
36
|
+
],
|
|
37
|
+
"target": "node18",
|
|
38
|
+
"outDir": "dist",
|
|
39
|
+
"clean": true,
|
|
40
|
+
"banner": {
|
|
41
|
+
"js": "#!/usr/bin/env node"
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"dependencies": {
|
|
45
|
+
"@modelcontextprotocol/sdk": "1.27.1",
|
|
46
|
+
"zod": "3.24.0"
|
|
47
|
+
},
|
|
48
|
+
"devDependencies": {
|
|
49
|
+
"@types/node": "25.3.0",
|
|
50
|
+
"tsup": "^8.0.0",
|
|
51
|
+
"tsx": "^4.7.0",
|
|
52
|
+
"typescript": "5.9.3"
|
|
53
|
+
}
|
|
54
|
+
}
|