@arc-ui/community-mcp 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.
- package/LICENSE +21 -0
- package/README.md +77 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +104068 -0
- package/dist/types/components.d.ts +798 -0
- package/package.json +44 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 BT plc
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Arc Community MCP Server
|
|
2
|
+
|
|
3
|
+
A Model Context Protocol (MCP) server that provides AI assistants with access to the Arc Community UI component library. Query community components and their TypeScript APIs directly from your AI assistant.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **get_community_components_list** — Returns a complete list of all available Arc Community components
|
|
8
|
+
- **get_community_api_info** — Fetches TypeScript interface definitions and prop types for a community component
|
|
9
|
+
|
|
10
|
+
> **Coming soon:** Documentation, coding rules, and Storybook link tools will be added in future versions.
|
|
11
|
+
|
|
12
|
+
## Setup
|
|
13
|
+
|
|
14
|
+
### Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @arc-ui/community-mcp
|
|
18
|
+
# or
|
|
19
|
+
pnpm install @arc-ui/community-mcp
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Kiro CLI
|
|
23
|
+
|
|
24
|
+
#### Local (workspace)
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
kiro-cli mcp add --name community-mcp --command npx --args @arc-ui/community-mcp
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Or manually add to `.kiro/settings/mcp.json`:
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"mcpServers": {
|
|
35
|
+
"community-mcp": {
|
|
36
|
+
"command": "npx",
|
|
37
|
+
"args": ["-y", "@arc-ui/community-mcp"]
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### Global
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
kiro-cli mcp add --name community-mcp --command npx --args @arc-ui/community-mcp --scope global
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Amazon Q (VS Code)
|
|
50
|
+
|
|
51
|
+
Add the MCP server via the Amazon Q Chat panel in VS Code, or manually create/update `.vscode/mcp.json` in your project:
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"servers": {
|
|
56
|
+
"community-mcp": {
|
|
57
|
+
"command": "npx",
|
|
58
|
+
"args": ["-y", "@arc-ui/community-mcp"]
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Example Queries
|
|
65
|
+
|
|
66
|
+
Once configured, you can ask your AI assistant:
|
|
67
|
+
|
|
68
|
+
- _"What community components are available?"_
|
|
69
|
+
- _"Show me the props for the Accordion component"_
|
|
70
|
+
- _"What's the API for FeaturePost?"_
|
|
71
|
+
- _"How do I use the CopyLead component?"_
|
|
72
|
+
|
|
73
|
+
## Support
|
|
74
|
+
|
|
75
|
+
- **Slack**: `#arc-help-and-support` (BT Business CDO Slack)
|
|
76
|
+
- **Email**: ui-digital-ent-int@bt.com
|
|
77
|
+
- **Teams**: [Arc Help and Support](https://teams.microsoft.com/l/channel/19%3Adae83c7699a64a29b6d36a740a2c8268%40thread.tacv2/Arc%20Help%20and%20Support?groupId=54ad8ab1-870a-4948-a8d0-c6c375806d65&tenantId=a7f35688-9c00-4d5e-ba41-29f146377ab0)
|
package/dist/index.d.ts
ADDED