@adobe/spectrum-design-data-mcp 1.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/CHANGELOG.md +48 -0
- package/LICENSE +201 -0
- package/README.md +190 -0
- package/package.json +59 -0
- package/src/cli.js +42 -0
- package/src/data/schemas.js +150 -0
- package/src/data/tokens.js +111 -0
- package/src/index.js +97 -0
- package/src/tools/schemas.js +472 -0
- package/src/tools/tokens.js +581 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @adobe/spectrum-design-data-mcp
|
|
2
|
+
|
|
3
|
+
## 1.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [#568](https://github.com/adobe/spectrum-tokens/pull/568) [`34028ea`](https://github.com/adobe/spectrum-tokens/commit/34028eaf2ba3940baa8044fda2655adc6153fb97) Thanks [@GarthDB](https://github.com/GarthDB)! - Initial release of Spectrum Design Data MCP server
|
|
8
|
+
|
|
9
|
+
This is the first release of the Model Context Protocol server that provides AI tools with structured access to Adobe Spectrum design system data, including design tokens and component API schemas.
|
|
10
|
+
|
|
11
|
+
Features:
|
|
12
|
+
- Query design tokens by name, type, or category
|
|
13
|
+
- Find tokens for specific component use cases
|
|
14
|
+
- Get component-specific token recommendations
|
|
15
|
+
- Access component API schemas and validation
|
|
16
|
+
- Type definitions and schema validation tools
|
|
17
|
+
|
|
18
|
+
This enables AI assistants to provide intelligent design guidance and automate design token usage across the Spectrum ecosystem.
|
|
19
|
+
|
|
20
|
+
## 0.2.0
|
|
21
|
+
|
|
22
|
+
### Minor Changes
|
|
23
|
+
|
|
24
|
+
- Initial release of Spectrum Design Data MCP server
|
|
25
|
+
|
|
26
|
+
This new package provides a Model Context Protocol (MCP) server that enables AI tools to query and interact with Spectrum design system data. Features include:
|
|
27
|
+
- **Design Token Tools**: Query tokens by name, type, or category; get token details and categories
|
|
28
|
+
- **Component Schema Tools**: Search component schemas, validate properties, and explore type definitions
|
|
29
|
+
- **Local Execution**: Runs as a local npm package with no external dependencies or hosting requirements
|
|
30
|
+
- **Extensible Architecture**: Designed to support future design data like component anatomy and patterns
|
|
31
|
+
|
|
32
|
+
The MCP server provides structured access to:
|
|
33
|
+
- All Spectrum design tokens from `@adobe/spectrum-tokens`
|
|
34
|
+
- Component API schemas from `@adobe/spectrum-component-api-schemas`
|
|
35
|
+
|
|
36
|
+
AI assistants can now understand and work with Spectrum design data through standardized MCP tools.
|
|
37
|
+
|
|
38
|
+
## 0.1.0
|
|
39
|
+
|
|
40
|
+
### Minor Changes
|
|
41
|
+
|
|
42
|
+
- Initial release of Spectrum Design Data MCP server
|
|
43
|
+
- Added support for design token querying and retrieval
|
|
44
|
+
- Added support for component schema validation and exploration
|
|
45
|
+
- Implemented token tools: query-tokens, get-token-categories, get-token-details
|
|
46
|
+
- Implemented schema tools: query-component-schemas, get-component-schema, list-components, validate-component-props, get-type-schemas
|
|
47
|
+
- Added CLI interface for starting the MCP server
|
|
48
|
+
- Added comprehensive test coverage
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# Spectrum Design Data MCP Server
|
|
2
|
+
|
|
3
|
+
A Model Context Protocol (MCP) server that provides AI tools with structured access to Adobe Spectrum design system data, including design tokens and component API schemas.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This MCP server enables AI assistants to query and interact with Spectrum design data through a standardized protocol. It provides access to:
|
|
8
|
+
|
|
9
|
+
- **Design Tokens**: Color palettes, typography, layout tokens, and semantic tokens
|
|
10
|
+
- **Component Schemas**: API definitions and validation schemas for Spectrum components
|
|
11
|
+
- **Future**: Component anatomy, design patterns, and guidelines
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g @adobe/spectrum-design-data-mcp
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
### Starting the MCP Server
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Start the server (default command)
|
|
25
|
+
spectrum-design-data-mcp
|
|
26
|
+
|
|
27
|
+
# Or explicitly start
|
|
28
|
+
spectrum-design-data-mcp start
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The server runs locally and communicates via stdio with MCP-compatible AI clients.
|
|
32
|
+
|
|
33
|
+
### Available Tools
|
|
34
|
+
|
|
35
|
+
#### Token Tools
|
|
36
|
+
|
|
37
|
+
- **`query-tokens`**: Search and retrieve design tokens by name, type, or category
|
|
38
|
+
- **`find-tokens-by-use-case`** ⭐: Find appropriate tokens for specific component use cases (e.g., "button background", "text color", "error state")
|
|
39
|
+
- **`get-component-tokens`** ⭐: Get all tokens related to a specific component type
|
|
40
|
+
- **`get-design-recommendations`** ⭐: Get token recommendations for design decisions and component states
|
|
41
|
+
- **`get-token-categories`**: List all available token categories
|
|
42
|
+
- **`get-token-details`**: Get detailed information about a specific token
|
|
43
|
+
|
|
44
|
+
#### Schema Tools
|
|
45
|
+
|
|
46
|
+
- **`query-component-schemas`**: Search component API schemas
|
|
47
|
+
- **`get-component-schema`**: Get the complete schema for a specific component
|
|
48
|
+
- **`list-components`**: List all available components with schemas
|
|
49
|
+
- **`validate-component-props`**: Validate component properties against schemas
|
|
50
|
+
- **`get-type-schemas`**: Get type definitions used in schemas
|
|
51
|
+
|
|
52
|
+
## Configuration with AI Clients
|
|
53
|
+
|
|
54
|
+
### Claude Desktop
|
|
55
|
+
|
|
56
|
+
Add to your Claude Desktop configuration:
|
|
57
|
+
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"mcpServers": {
|
|
61
|
+
"spectrum-design-data": {
|
|
62
|
+
"command": "spectrum-design-data-mcp",
|
|
63
|
+
"args": []
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Other MCP Clients
|
|
70
|
+
|
|
71
|
+
The server uses stdio transport and follows the MCP specification. Refer to your client's documentation for configuration details.
|
|
72
|
+
|
|
73
|
+
## Examples
|
|
74
|
+
|
|
75
|
+
### Component Building Workflow ⭐
|
|
76
|
+
|
|
77
|
+
#### Finding Tokens for Component Use Cases
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
Human: I'm building a primary action button. What design tokens should I use for the background color?
|
|
81
|
+
|
|
82
|
+
AI: I'll help you find the appropriate tokens for a primary button background.
|
|
83
|
+
|
|
84
|
+
[Uses find-tokens-by-use-case with useCase="button background" and componentType="button"]
|
|
85
|
+
|
|
86
|
+
For a primary action button background, I recommend these Spectrum tokens:
|
|
87
|
+
- accent-color-100: Primary accent color for default state
|
|
88
|
+
- accent-color-200: For hover states
|
|
89
|
+
- accent-color-300: For pressed/active states
|
|
90
|
+
- floating-action-button-drop-shadow-color: For drop shadows
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
#### Design Intent Recommendations
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
Human: What tokens should I use for error messaging in my form validation?
|
|
97
|
+
|
|
98
|
+
AI: I'll find tokens for error state messaging.
|
|
99
|
+
|
|
100
|
+
[Uses get-design-recommendations with intent="negative" and context="text"]
|
|
101
|
+
|
|
102
|
+
For error messaging, use these Spectrum tokens:
|
|
103
|
+
- negative-color-100: Primary error text color
|
|
104
|
+
- negative-background-color-default: Error background areas
|
|
105
|
+
- negative-border-color: Error state borders
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
#### Component-Specific Token Discovery
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
Human: Show me all available button-related design tokens.
|
|
112
|
+
|
|
113
|
+
AI: I'll gather all button-related tokens from the Spectrum system.
|
|
114
|
+
|
|
115
|
+
[Uses get-component-tokens with componentName="button"]
|
|
116
|
+
|
|
117
|
+
Found 57 button-related tokens across categories:
|
|
118
|
+
- Color tokens (2): floating-action-button colors
|
|
119
|
+
- Layout tokens (55): button sizing, padding, spacing
|
|
120
|
+
- Examples: radio-button-control-size-small, action-button-edge-to-hold-icon...
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Traditional Token Queries
|
|
124
|
+
|
|
125
|
+
#### Querying Color Tokens
|
|
126
|
+
|
|
127
|
+
```
|
|
128
|
+
Human: What blue color tokens are available in Spectrum?
|
|
129
|
+
|
|
130
|
+
AI: I'll search for blue color tokens in the Spectrum design system.
|
|
131
|
+
|
|
132
|
+
[Uses query-tokens tool with query="blue" and category="color"]
|
|
133
|
+
|
|
134
|
+
The Spectrum design system includes several blue color tokens:
|
|
135
|
+
- spectrum-blue-100: #e6f3ff
|
|
136
|
+
- spectrum-blue-200: #b3d9ff
|
|
137
|
+
- spectrum-blue-300: #80bfff
|
|
138
|
+
...
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
#### Validating Component Props
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
Human: Is this button configuration valid according to Spectrum?
|
|
145
|
+
|
|
146
|
+
AI: I'll validate those button properties against the Spectrum schema.
|
|
147
|
+
|
|
148
|
+
[Uses validate-component-props tool with component="action-button"]
|
|
149
|
+
|
|
150
|
+
The configuration is valid! All required properties are present and the types match the expected schema.
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## Development
|
|
154
|
+
|
|
155
|
+
### Building from Source
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
git clone https://github.com/adobe/spectrum-tokens.git
|
|
159
|
+
cd spectrum-tokens
|
|
160
|
+
pnpm install
|
|
161
|
+
cd tools/spectrum-design-data-mcp
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Testing
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
pnpm test
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Project Structure
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
src/
|
|
174
|
+
├── index.js # Main MCP server
|
|
175
|
+
├── cli.js # CLI interface
|
|
176
|
+
├── tools/ # MCP tool implementations
|
|
177
|
+
│ ├── tokens.js # Token-related tools
|
|
178
|
+
│ └── schemas.js # Schema-related tools
|
|
179
|
+
└── data/ # Data access layer
|
|
180
|
+
├── tokens.js # Token data access
|
|
181
|
+
└── schemas.js # Schema data access
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
## License
|
|
185
|
+
|
|
186
|
+
Apache-2.0 © Adobe
|
|
187
|
+
|
|
188
|
+
## Contributing
|
|
189
|
+
|
|
190
|
+
This project is part of the Spectrum Design System. Please see the main [contribution guidelines](../../CONTRIBUTING.md) for details on how to contribute.
|
package/package.json
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@adobe/spectrum-design-data-mcp",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Model Context Protocol server for Spectrum design data including tokens, schemas, and component anatomy",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"mcp",
|
|
7
|
+
"model-context-protocol",
|
|
8
|
+
"spectrum",
|
|
9
|
+
"design-tokens",
|
|
10
|
+
"component-schemas",
|
|
11
|
+
"component-anatomy",
|
|
12
|
+
"design-data",
|
|
13
|
+
"design-system",
|
|
14
|
+
"adobe",
|
|
15
|
+
"ai-tools"
|
|
16
|
+
],
|
|
17
|
+
"type": "module",
|
|
18
|
+
"main": "./src/index.js",
|
|
19
|
+
"bin": {
|
|
20
|
+
"spectrum-design-data-mcp": "./src/cli.js"
|
|
21
|
+
},
|
|
22
|
+
"files": [
|
|
23
|
+
"src/",
|
|
24
|
+
"README.md",
|
|
25
|
+
"CHANGELOG.md",
|
|
26
|
+
"LICENSE"
|
|
27
|
+
],
|
|
28
|
+
"engines": {
|
|
29
|
+
"node": ">=20.12.0",
|
|
30
|
+
"pnpm": ">=10.11.0"
|
|
31
|
+
},
|
|
32
|
+
"repository": {
|
|
33
|
+
"type": "git",
|
|
34
|
+
"url": "git+https://github.com/adobe/spectrum-tokens.git",
|
|
35
|
+
"directory": "tools/spectrum-design-data-mcp"
|
|
36
|
+
},
|
|
37
|
+
"author": "Garth Braithwaite <garthdb@gmail.com> (http://garthdb.com/)",
|
|
38
|
+
"license": "Apache-2.0",
|
|
39
|
+
"bugs": {
|
|
40
|
+
"url": "https://github.com/adobe/spectrum-tokens/issues"
|
|
41
|
+
},
|
|
42
|
+
"homepage": "https://github.com/adobe/spectrum-tokens/tree/main/tools/spectrum-design-data-mcp#readme",
|
|
43
|
+
"publishConfig": {
|
|
44
|
+
"access": "public",
|
|
45
|
+
"registry": "https://registry.npmjs.org/"
|
|
46
|
+
},
|
|
47
|
+
"dependencies": {
|
|
48
|
+
"@modelcontextprotocol/sdk": "^0.5.0",
|
|
49
|
+
"commander": "^13.1.0",
|
|
50
|
+
"@adobe/spectrum-tokens": "13.13.0",
|
|
51
|
+
"@adobe/spectrum-component-api-schemas": "1.0.2"
|
|
52
|
+
},
|
|
53
|
+
"devDependencies": {
|
|
54
|
+
"ava": "^6.0.1"
|
|
55
|
+
},
|
|
56
|
+
"scripts": {
|
|
57
|
+
"test": "ava"
|
|
58
|
+
}
|
|
59
|
+
}
|
package/src/cli.js
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
/*
|
|
4
|
+
Copyright 2024 Adobe. All rights reserved.
|
|
5
|
+
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
you may not use this file except in compliance with the License. You may obtain a copy
|
|
7
|
+
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software distributed under
|
|
10
|
+
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
11
|
+
OF ANY KIND, either express or implied. See the License for the specific language
|
|
12
|
+
governing permissions and limitations under the License.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { Command } from "commander";
|
|
16
|
+
import { startServer } from "./index.js";
|
|
17
|
+
|
|
18
|
+
const program = new Command();
|
|
19
|
+
|
|
20
|
+
program
|
|
21
|
+
.name("spectrum-design-data-mcp")
|
|
22
|
+
.description("Model Context Protocol server for Spectrum design data")
|
|
23
|
+
.version("0.1.0");
|
|
24
|
+
|
|
25
|
+
program
|
|
26
|
+
.command("start")
|
|
27
|
+
.description("Start the MCP server with stdio transport")
|
|
28
|
+
.action(async () => {
|
|
29
|
+
try {
|
|
30
|
+
await startServer();
|
|
31
|
+
} catch (error) {
|
|
32
|
+
console.error("Failed to start MCP server:", error);
|
|
33
|
+
process.exit(1);
|
|
34
|
+
}
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
// If no command is provided, default to start
|
|
38
|
+
if (process.argv.length === 2) {
|
|
39
|
+
process.argv.push("start");
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
program.parse();
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2024 Adobe. All rights reserved.
|
|
3
|
+
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License. You may obtain a copy
|
|
5
|
+
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
6
|
+
|
|
7
|
+
Unless required by applicable law or agreed to in writing, software distributed under
|
|
8
|
+
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
9
|
+
OF ANY KIND, either express or implied. See the License for the specific language
|
|
10
|
+
governing permissions and limitations under the License.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import { readFileSync, readdirSync, statSync } from "fs";
|
|
14
|
+
import { join, dirname } from "path";
|
|
15
|
+
import { fileURLToPath } from "url";
|
|
16
|
+
|
|
17
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
18
|
+
const __dirname = dirname(__filename);
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Get schema data from the component-schemas package
|
|
22
|
+
* @returns {Promise<Object>} Schema data organized by type
|
|
23
|
+
*/
|
|
24
|
+
export async function getSchemaData() {
|
|
25
|
+
try {
|
|
26
|
+
// Try to import from the workspace package first
|
|
27
|
+
const componentSchemas = await import(
|
|
28
|
+
"@adobe/spectrum-component-api-schemas"
|
|
29
|
+
);
|
|
30
|
+
|
|
31
|
+
// If the package exports schema data directly, use it
|
|
32
|
+
if (componentSchemas.default || componentSchemas.schemas) {
|
|
33
|
+
return componentSchemas.default || componentSchemas.schemas;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
// Otherwise, read the schema files directly from the package
|
|
37
|
+
return await loadSchemaFilesDirectly();
|
|
38
|
+
} catch (error) {
|
|
39
|
+
console.error(
|
|
40
|
+
"Failed to load schema data from package, trying direct file access:",
|
|
41
|
+
error,
|
|
42
|
+
);
|
|
43
|
+
return await loadSchemaFilesDirectly();
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Load schema files directly from the repository structure
|
|
49
|
+
* @returns {Promise<Object>} Schema data
|
|
50
|
+
*/
|
|
51
|
+
async function loadSchemaFilesDirectly() {
|
|
52
|
+
const schemaData = {
|
|
53
|
+
components: {},
|
|
54
|
+
types: {},
|
|
55
|
+
};
|
|
56
|
+
|
|
57
|
+
// Path to the schemas directory
|
|
58
|
+
const schemasPath = join(
|
|
59
|
+
__dirname,
|
|
60
|
+
"../../../../packages/component-schemas/schemas",
|
|
61
|
+
);
|
|
62
|
+
|
|
63
|
+
// Load component schemas
|
|
64
|
+
const componentsPath = join(schemasPath, "components");
|
|
65
|
+
try {
|
|
66
|
+
const componentFiles = readdirSync(componentsPath).filter((file) =>
|
|
67
|
+
file.endsWith(".json"),
|
|
68
|
+
);
|
|
69
|
+
|
|
70
|
+
for (const fileName of componentFiles) {
|
|
71
|
+
try {
|
|
72
|
+
const filePath = join(componentsPath, fileName);
|
|
73
|
+
const fileContent = readFileSync(filePath, "utf8");
|
|
74
|
+
schemaData.components[fileName] = JSON.parse(fileContent);
|
|
75
|
+
} catch (error) {
|
|
76
|
+
console.error(`Failed to load component schema ${fileName}:`, error);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
} catch (error) {
|
|
80
|
+
console.error("Failed to read components directory:", error);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
// Load type schemas
|
|
84
|
+
const typesPath = join(schemasPath, "types");
|
|
85
|
+
try {
|
|
86
|
+
const typeFiles = readdirSync(typesPath).filter((file) =>
|
|
87
|
+
file.endsWith(".json"),
|
|
88
|
+
);
|
|
89
|
+
|
|
90
|
+
for (const fileName of typeFiles) {
|
|
91
|
+
try {
|
|
92
|
+
const filePath = join(typesPath, fileName);
|
|
93
|
+
const fileContent = readFileSync(filePath, "utf8");
|
|
94
|
+
schemaData.types[fileName] = JSON.parse(fileContent);
|
|
95
|
+
} catch (error) {
|
|
96
|
+
console.error(`Failed to load type schema ${fileName}:`, error);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
} catch (error) {
|
|
100
|
+
console.error("Failed to read types directory:", error);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
return schemaData;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Get available component names
|
|
108
|
+
* @returns {Promise<Array<string>>} List of component names
|
|
109
|
+
*/
|
|
110
|
+
export async function getComponentNames() {
|
|
111
|
+
const schemaData = await getSchemaData();
|
|
112
|
+
return Object.keys(schemaData.components).map((fileName) =>
|
|
113
|
+
fileName.replace(".json", ""),
|
|
114
|
+
);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* Get schema for a specific component
|
|
119
|
+
* @param {string} componentName - Component name
|
|
120
|
+
* @returns {Promise<Object|null>} Component schema
|
|
121
|
+
*/
|
|
122
|
+
export async function getComponentSchema(componentName) {
|
|
123
|
+
const schemaData = await getSchemaData();
|
|
124
|
+
const fileName = componentName.endsWith(".json")
|
|
125
|
+
? componentName
|
|
126
|
+
: `${componentName}.json`;
|
|
127
|
+
return schemaData.components[fileName] || null;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Get available type names
|
|
132
|
+
* @returns {Promise<Array<string>>} List of type names
|
|
133
|
+
*/
|
|
134
|
+
export async function getTypeNames() {
|
|
135
|
+
const schemaData = await getSchemaData();
|
|
136
|
+
return Object.keys(schemaData.types).map((fileName) =>
|
|
137
|
+
fileName.replace(".json", ""),
|
|
138
|
+
);
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Get schema for a specific type
|
|
143
|
+
* @param {string} typeName - Type name
|
|
144
|
+
* @returns {Promise<Object|null>} Type schema
|
|
145
|
+
*/
|
|
146
|
+
export async function getTypeSchema(typeName) {
|
|
147
|
+
const schemaData = await getSchemaData();
|
|
148
|
+
const fileName = typeName.endsWith(".json") ? typeName : `${typeName}.json`;
|
|
149
|
+
return schemaData.types[fileName] || null;
|
|
150
|
+
}
|