@workday/canvas-kit-mcp 13.2.41

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 ADDED
@@ -0,0 +1,126 @@
1
+ Apache License, Version 2.0 Apache License Version 2.0, January 2004
2
+
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and
8
+ distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the
9
+ copyright owner or entity authorized by the copyright owner that is granting the License. "Legal
10
+ Entity" shall mean the union of the acting entity and all other entities that control, are
11
+ controlled by, or are under common control with that entity. For the purposes of this definition,
12
+ "control" means (i) the power, direct or indirect, to cause the direction or management of such
13
+ entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
14
+ outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an
15
+ individual or Legal Entity exercising permissions granted by this License. "Source" form shall
16
+ mean the preferred form for making modifications, including but not limited to software source
17
+ code, documentation source, and configuration files. "Object" form shall mean any form resulting
18
+ from mechanical transformation or translation of a Source form, including but not limited to
19
+ compiled object code, generated documentation, and conversions to other media types. "Work" shall
20
+ mean the work of authorship, whether in Source or Object form, made available under the License,
21
+ as indicated by a copyright notice that is included in or attached to the work (an example is
22
+ provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or
23
+ Object form, that is based on (or derived from) the Work and for which the editorial revisions,
24
+ annotations, elaborations, or other modifications represent, as a whole, an original work of
25
+ authorship. For the purposes of this License, Derivative Works shall not include works that
26
+ remain separable from, or merely link (or bind by name) to the interfaces of, the Work and
27
+ Derivative Works thereof. "Contribution" shall mean any work of authorship, including the
28
+ original version of the Work and any modifications or additions to that Work or Derivative Works
29
+ thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright
30
+ owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner.
31
+ For the purposes of this definition, "submitted" means any form of electronic, verbal, or written
32
+ communication sent to the Licensor or its representatives, including but not limited to
33
+ communication on electronic mailing lists, source code control systems, and issue tracking
34
+ systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and
35
+ improving the Work, but excluding communication that is conspicuously marked or otherwise
36
+ designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean
37
+ Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by
38
+ Licensor and subsequently incorporated within the Work.
39
+
40
+ 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor
41
+ hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
42
+ copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform,
43
+ sublicense, and distribute the Work and such Derivative Works in Source or Object form.
44
+
45
+ 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor
46
+ hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
47
+ (except as stated in this section) patent license to make, have made, use, offer to sell, sell,
48
+ import, and otherwise transfer the Work, where such license applies only to those patent claims
49
+ licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or
50
+ by combination of their Contribution(s) with the Work to which such Contribution(s) was
51
+ submitted. If You institute patent litigation against any entity (including a cross-claim or
52
+ counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work
53
+ constitutes direct or contributory patent infringement, then any patent licenses granted to You
54
+ under this License for that Work shall terminate as of the date such litigation is filed.
55
+
56
+ 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof
57
+ in any medium, with or without modifications, and in Source or Object form, provided that You
58
+ meet the following conditions: You must give any other recipients of the Work or Derivative Works
59
+ a copy of this License; and You must cause any modified files to carry prominent notices stating
60
+ that You changed the files; and You must retain, in the Source form of any Derivative Works that
61
+ You distribute, all copyright, patent, trademark, and attribution notices from the Source form of
62
+ the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If
63
+ the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
64
+ that You distribute must include a readable copy of the attribution notices contained within such
65
+ NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
66
+ at least one of the following places: within a NOTICE text file distributed as part of the
67
+ Derivative Works; within the Source form or documentation, if provided along with the Derivative
68
+ Works; or, within a display generated by the Derivative Works, if and wherever such third-party
69
+ notices normally appear. The contents of the NOTICE file are for informational purposes only and
70
+ do not modify the License. You may add Your own attribution notices within Derivative Works that
71
+ You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
72
+ additional attribution notices cannot be construed as modifying the License. You may add Your own
73
+ copyright statement to Your modifications and may provide additional or different license terms
74
+ and conditions for use, reproduction, or distribution of Your modifications, or for any such
75
+ Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work
76
+ otherwise complies with the conditions stated in this License.
77
+
78
+ 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution
79
+ intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms
80
+ and conditions of this License, without any additional terms or conditions. Notwithstanding the
81
+ above, nothing herein shall supersede or modify the terms of any separate license agreement you
82
+ may have executed with Licensor regarding such Contributions.
83
+
84
+ 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service
85
+ marks, or product names of the Licensor, except as required for reasonable and customary use in
86
+ describing the origin of the Work and reproducing the content of the NOTICE file.
87
+
88
+ 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor
89
+ provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT
90
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation,
91
+ any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
92
+ PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or
93
+ redistributing the Work and assume any risks associated with Your exercise of permissions under
94
+ this License.
95
+
96
+ 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including
97
+ negligence), contract, or otherwise, unless required by applicable law (such as deliberate and
98
+ grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for
99
+ damages, including any direct, indirect, special, incidental, or consequential damages of any
100
+ character arising as a result of this License or out of the use or inability to use the Work
101
+ (including but not limited to damages for loss of goodwill, work stoppage, computer failure or
102
+ malfunction, or any and all other commercial damages or losses), even if such Contributor has
103
+ been advised of the possibility of such damages.
104
+
105
+ 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works
106
+ thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty,
107
+ indemnity, or other liability obligations and/or rights consistent with this License. However, in
108
+ accepting such obligations, You may act only on Your own behalf and on Your sole responsibility,
109
+ not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each
110
+ Contributor harmless for any liability incurred by, or claims asserted against, such Contributor
111
+ by reason of your accepting any such warranty or additional liability.
112
+
113
+ END OF TERMS AND CONDITIONS
114
+
115
+ ©2020. Workday, Inc. All rights reserved. Workday and the Workday logo are registered trademarks of
116
+ Workday, Inc. All other brand and product names are trademarks or registered trademarks of their
117
+ respective holders.
118
+
119
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
120
+ compliance with the License. You may obtain a copy of the License at
121
+ http://www.apache.org/licenses/LICENSE-2.0
122
+
123
+ Unless required by applicable law or agreed to in writing, software distributed under the License is
124
+ distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
125
+ implied. See the License for the specific language governing permissions and limitations under the
126
+ License.
package/README.md ADDED
@@ -0,0 +1,75 @@
1
+ # Canvas Kit MCP
2
+
3
+ Our MCP server provides resources to help you upgrade Canvas Kit.
4
+
5
+ ## Cursor Quick Install
6
+
7
+ <a href="https://cursor.com/en-US/install-mcp?name=canvas-kit-mcp&config=eyJjb21tYW5kIjoibnB4IC15IEB3b3JrZGF5L2NhbnZhcy1raXQtbWNwIn0%3D">
8
+ <picture>
9
+ <source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/deeplink/mcp-install-light.svg">
10
+ <source media="(prefers-color-scheme: light)" srcset="https://cursor.com/deeplink/mcp-install-dark.svg">
11
+ <img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install MCP server in Cursor">
12
+ </picture>
13
+ </a>
14
+
15
+ ---
16
+
17
+ ## Not Running Cursor?
18
+
19
+ You will need to check how to install MCP servers, but the config will look something like:
20
+
21
+ ```json
22
+ {
23
+ "mcpServers": {
24
+ {
25
+ "canvas-kit-mcp": {
26
+ "command": "npx",
27
+ "args": [
28
+ "-y",
29
+ "@workday/canvas-kit-mcp"
30
+ ]
31
+ }
32
+ }
33
+ }
34
+ }
35
+ ```
36
+
37
+ ## Contributing
38
+
39
+ Canvas Kit MCP is has two exports.
40
+
41
+ `src/cli.js` is a node server that can be invoked via npx for local stdio.
42
+
43
+ `src/index.js` provides low level module exports. You can use these extend the sever or host it
44
+ using other transports.
45
+
46
+ ### Testing Locally
47
+
48
+ #### MCP Inspector
49
+
50
+ The inspector requires node > 22 so you will need to temporary switch:
51
+
52
+ ```bash
53
+ nvm use 22
54
+ yarn build
55
+ npx @modelcontextprotocol/inspector node dist/cli.js"
56
+ ```
57
+
58
+ #### Local IDE
59
+
60
+ Add an entry to your MCP servers list:
61
+
62
+ ```json
63
+ {
64
+ "mcpServers": {
65
+ {
66
+ "canvas-kit-mcp": {
67
+ "command": "node",
68
+ "args": [
69
+ "~/path/to/canvas/kit/modules/mcp/dist/cli.js"
70
+ ]
71
+ }
72
+ }
73
+ }
74
+ }
75
+ ```