@machfivetechchicago/machvive-webmcp-ai 5.5.5
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 +202 -0
- package/README.md +142 -0
- package/index.d.ts +14 -0
- package/index.js +15 -0
- package/package.json +61 -0
- package/src/wc/machvive-lorum-ipsum/machvive-lorum-ipsum.d.ts +8 -0
- package/src/wc/machvive-lorum-ipsum/machvive-lorum-ipsum.js +22 -0
- package/src/wc/machvive-webmcp-polyfill/machvive-webmcp-polyfill.d.ts +69 -0
- package/src/wc/machvive-webmcp-polyfill/machvive-webmcp-polyfill.js +146 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 MachFiveTech Chicago
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
<h1 align="center">machvive-webmcp-ai</h1>
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<strong>Remember when the Web was fun?</strong><br>
|
|
5
|
+
Vanilla Web Components that make a page agent-ready — by
|
|
6
|
+
<a href="https://github.com/Mach-Five-Group">MachFiveTech Chicago</a>.
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://www.npmjs.com/package/@machfivetechchicago/machvive-webmcp-ai"><img alt="npm" src="https://img.shields.io/npm/v/@machfivetechchicago/machvive-webmcp-ai.svg"></a>
|
|
11
|
+
<a href="LICENSE"><img alt="license" src="https://img.shields.io/npm/l/@machfivetechchicago/machvive-webmcp-ai.svg"></a>
|
|
12
|
+
<img alt="types" src="https://img.shields.io/badge/types-included-blue.svg">
|
|
13
|
+
<img alt="dependencies" src="https://img.shields.io/badge/dependencies-0-brightgreen.svg">
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
No framework, no build step, no runtime dependencies — just standards-based custom
|
|
17
|
+
elements with Shadow DOM that work anywhere `customElements` does.
|
|
18
|
+
|
|
19
|
+
| Component | Tag | What it does |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| WebMCP polyfill | `<machvive-webmcp-polyfill>` | Shims `navigator.modelContext` so a page can expose tools to AI agents |
|
|
22
|
+
| Lorum Ipsum | `<machvive-lorum-ipsum>` | Placeholder copy that projects slotted content |
|
|
23
|
+
|
|
24
|
+
## ⚡ Integration with Vite (Vanilla JS)
|
|
25
|
+
|
|
26
|
+
This package is optimized for modern ESM environments like Vite. You can import individual components or the entire library at once.
|
|
27
|
+
|
|
28
|
+
### 1. Installation
|
|
29
|
+
Install the package via NPM into your Vite project:
|
|
30
|
+
```bash
|
|
31
|
+
npm install @machfivetechchicago/machvive-webmcp-ai
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### 2. Import Components
|
|
35
|
+
Inside your main entry script (e.g., `main.js` or `index.js`), import the components you need to register them with the browser's `customElements` registry.
|
|
36
|
+
|
|
37
|
+
#### Option A: Cherry-Pick (Recommended for smaller production bundles)
|
|
38
|
+
```javascript
|
|
39
|
+
// Import only the specific tools your app requires
|
|
40
|
+
import '@machfivetechchicago/machvive-webmcp-ai/webmcp-polyfill';
|
|
41
|
+
import '@machfivetechchicago/machvive-webmcp-ai/lorum-ipsum';
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Option B: Bulk Import (Registers all components at once)
|
|
45
|
+
```javascript
|
|
46
|
+
// Quick setup to make all components available globally
|
|
47
|
+
import '@machfivetechchicago/machvive-webmcp-ai';
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 3. Use in HTML
|
|
51
|
+
Once imported, use the tags directly in your markup. Because these are vanilla Web Components utilizing the Shadow DOM, they are fully isolated and work out of the box in `index.html`:
|
|
52
|
+
|
|
53
|
+
```html
|
|
54
|
+
<!DOCTYPE html>
|
|
55
|
+
<html lang="en">
|
|
56
|
+
<head>
|
|
57
|
+
<meta charset="UTF-8" />
|
|
58
|
+
<title>Vite App</title>
|
|
59
|
+
</head>
|
|
60
|
+
<body>
|
|
61
|
+
<!-- Use your custom elements anywhere -->
|
|
62
|
+
<machvive-lorum-ipsum></machvive-lorum-ipsum>
|
|
63
|
+
|
|
64
|
+
<script type="module" src="/main.js"></script>
|
|
65
|
+
</body>
|
|
66
|
+
</html>
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## 🤖 WebMCP Polyfill
|
|
70
|
+
|
|
71
|
+
`machvive-webmcp-polyfill` installs a `navigator.modelContext` shim following the
|
|
72
|
+
[W3C WebMCP proposal](https://webmachinelearning.github.io/webmcp/docs/proposal.html),
|
|
73
|
+
so a page can declare agent-callable tools before browsers ship the API natively.
|
|
74
|
+
|
|
75
|
+
It is a no-op when the browser already implements WebMCP, so your page always talks
|
|
76
|
+
to the real implementation where one exists. Because the native API is
|
|
77
|
+
`[SecureContext]`, the polyfill installs only on HTTPS (and `localhost`).
|
|
78
|
+
|
|
79
|
+
```html
|
|
80
|
+
<machvive-webmcp-polyfill></machvive-webmcp-polyfill>
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Importing the module installs the shim immediately — you can register tools without
|
|
84
|
+
waiting for the element to upgrade:
|
|
85
|
+
|
|
86
|
+
```javascript
|
|
87
|
+
import '@machfivetechchicago/machvive-webmcp-ai/webmcp-polyfill';
|
|
88
|
+
|
|
89
|
+
navigator.modelContext.registerTool({
|
|
90
|
+
name: 'add_to_cart',
|
|
91
|
+
description: 'Add a product to the shopping cart',
|
|
92
|
+
inputSchema: {
|
|
93
|
+
type: 'object',
|
|
94
|
+
properties: { sku: { type: 'string', description: 'Product SKU' } },
|
|
95
|
+
required: ['sku']
|
|
96
|
+
},
|
|
97
|
+
execute: async ({ sku }) => {
|
|
98
|
+
await cart.add(sku);
|
|
99
|
+
return { content: [{ type: 'text', text: `Added ${sku} to cart.` }] };
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Use `unregisterTool(name)` to drop a single tool, or `provideContext({ tools })` to
|
|
105
|
+
replace the whole toolset when app state changes which tools make sense.
|
|
106
|
+
|
|
107
|
+
### Bridging to an agent
|
|
108
|
+
|
|
109
|
+
The polyfill is a registry — it has no transport. Bridge code (an extension, a
|
|
110
|
+
devtools panel, a test harness) discovers tools and invokes them:
|
|
111
|
+
|
|
112
|
+
```javascript
|
|
113
|
+
import { TOOLS_CHANGED_EVENT } from '@machfivetechchicago/machvive-webmcp-ai/webmcp-polyfill';
|
|
114
|
+
|
|
115
|
+
window.addEventListener(TOOLS_CHANGED_EVENT, (e) => console.log(e.detail.tools));
|
|
116
|
+
|
|
117
|
+
const result = await navigator.modelContext.callTool('add_to_cart', { sku: 'M5T-001' });
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
`navigator.modelContext.tools` returns the descriptors minus their handlers.
|
|
121
|
+
`callTool` never throws: a handler that rejects comes back as
|
|
122
|
+
`{ content: [...], isError: true }`.
|
|
123
|
+
|
|
124
|
+
## TypeScript
|
|
125
|
+
|
|
126
|
+
Declarations ship with the package — no `@types/*` needed. Importing a component
|
|
127
|
+
augments `HTMLElementTagNameMap`, so `querySelector` returns the real element type,
|
|
128
|
+
and the polyfill declares `navigator.modelContext` plus the change event:
|
|
129
|
+
|
|
130
|
+
```typescript
|
|
131
|
+
import '@machfivetechchicago/machvive-webmcp-ai/webmcp-polyfill';
|
|
132
|
+
import type { WebmcpToolResult } from '@machfivetechchicago/machvive-webmcp-ai';
|
|
133
|
+
|
|
134
|
+
const el = document.querySelector('machvive-lorum-ipsum'); // MachviveLorumIpsum | null
|
|
135
|
+
const res: WebmcpToolResult = await navigator.modelContext.callTool('add_to_cart', { sku: 'A' });
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Verified against `moduleResolution: "bundler"` and `"node16"` under `--strict`.
|
|
139
|
+
|
|
140
|
+
## License
|
|
141
|
+
|
|
142
|
+
[Apache-2.0](LICENSE) © MachFiveTech Chicago
|
package/index.d.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export { MachviveLorumIpsum } from './src/wc/machvive-lorum-ipsum/machvive-lorum-ipsum.js';
|
|
2
|
+
export {
|
|
3
|
+
MachviveWebmcpPolyfill,
|
|
4
|
+
installWebmcpPolyfill,
|
|
5
|
+
TOOLS_CHANGED_EVENT
|
|
6
|
+
} from './src/wc/machvive-webmcp-polyfill/machvive-webmcp-polyfill.js';
|
|
7
|
+
export type {
|
|
8
|
+
ModelContext,
|
|
9
|
+
WebmcpAgent,
|
|
10
|
+
WebmcpContent,
|
|
11
|
+
WebmcpToolDescriptor,
|
|
12
|
+
WebmcpToolResult,
|
|
13
|
+
WebmcpToolSummary
|
|
14
|
+
} from './src/wc/machvive-webmcp-polyfill/machvive-webmcp-polyfill.js';
|
package/index.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// Import all components to trigger their customElements.define() registration
|
|
2
|
+
import { MachviveLorumIpsum } from './src/wc/machvive-lorum-ipsum/machvive-lorum-ipsum.js';
|
|
3
|
+
import {
|
|
4
|
+
MachviveWebmcpPolyfill,
|
|
5
|
+
installWebmcpPolyfill,
|
|
6
|
+
TOOLS_CHANGED_EVENT
|
|
7
|
+
} from './src/wc/machvive-webmcp-polyfill/machvive-webmcp-polyfill.js';
|
|
8
|
+
|
|
9
|
+
// Export them all from a single entry point
|
|
10
|
+
export {
|
|
11
|
+
MachviveLorumIpsum,
|
|
12
|
+
MachviveWebmcpPolyfill,
|
|
13
|
+
installWebmcpPolyfill,
|
|
14
|
+
TOOLS_CHANGED_EVENT
|
|
15
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@machfivetechchicago/machvive-webmcp-ai",
|
|
3
|
+
"version": "5.5.5",
|
|
4
|
+
"description": "Remember when the Web was fun?",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"WebMCP",
|
|
7
|
+
"MCP",
|
|
8
|
+
"AI",
|
|
9
|
+
"Agent",
|
|
10
|
+
"Web",
|
|
11
|
+
"Component"
|
|
12
|
+
],
|
|
13
|
+
"homepage": "https://github.com/Mach-Five-Group/machvive-webmcp-ai#readme",
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/Mach-Five-Group/machvive-webmcp-ai/issues"
|
|
16
|
+
},
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/Mach-Five-Group/machvive-webmcp-ai.git"
|
|
20
|
+
},
|
|
21
|
+
"license": "Apache-2.0",
|
|
22
|
+
"author": "MachFiveTech Chicago",
|
|
23
|
+
"type": "module",
|
|
24
|
+
"sideEffects": true,
|
|
25
|
+
"engines": {
|
|
26
|
+
"node": ">=18"
|
|
27
|
+
},
|
|
28
|
+
"main": "index.js",
|
|
29
|
+
"types": "index.d.ts",
|
|
30
|
+
"exports": {
|
|
31
|
+
".": {
|
|
32
|
+
"types": "./index.d.ts",
|
|
33
|
+
"default": "./index.js"
|
|
34
|
+
},
|
|
35
|
+
"./lorum-ipsum": {
|
|
36
|
+
"types": "./src/wc/machvive-lorum-ipsum/machvive-lorum-ipsum.d.ts",
|
|
37
|
+
"default": "./src/wc/machvive-lorum-ipsum/machvive-lorum-ipsum.js"
|
|
38
|
+
},
|
|
39
|
+
"./webmcp-polyfill": {
|
|
40
|
+
"types": "./src/wc/machvive-webmcp-polyfill/machvive-webmcp-polyfill.d.ts",
|
|
41
|
+
"default": "./src/wc/machvive-webmcp-polyfill/machvive-webmcp-polyfill.js"
|
|
42
|
+
},
|
|
43
|
+
"./package.json": "./package.json"
|
|
44
|
+
},
|
|
45
|
+
"files": [
|
|
46
|
+
"index.js",
|
|
47
|
+
"index.d.ts",
|
|
48
|
+
"src"
|
|
49
|
+
],
|
|
50
|
+
"publishConfig": {
|
|
51
|
+
"access": "public"
|
|
52
|
+
},
|
|
53
|
+
"scripts": {
|
|
54
|
+
"test": "node --test --import ./test/setup.js \"test/*.test.js\"",
|
|
55
|
+
"test:watch": "node --test --watch --import ./test/setup.js \"test/*.test.js\"",
|
|
56
|
+
"prepublishOnly": "npm test"
|
|
57
|
+
},
|
|
58
|
+
"devDependencies": {
|
|
59
|
+
"jsdom": "^29.1.1"
|
|
60
|
+
}
|
|
61
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export class MachviveLorumIpsum extends HTMLElement {
|
|
2
|
+
constructor() {
|
|
3
|
+
super();
|
|
4
|
+
this.attachShadow({ mode: 'open' });
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
connectedCallback() {
|
|
8
|
+
this.shadowRoot.innerHTML = `
|
|
9
|
+
<style>
|
|
10
|
+
:host { display: block; font-family: sans-serif; color: #333; }
|
|
11
|
+
</style>
|
|
12
|
+
<div>
|
|
13
|
+
<slot>Lorem ipsum dolor sit amet...</slot>
|
|
14
|
+
</div>
|
|
15
|
+
`;
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// Automatically register the component if it hasn't been already
|
|
20
|
+
if (!customElements.get('machvive-lorum-ipsum')) {
|
|
21
|
+
customElements.define('machvive-lorum-ipsum', MachviveLorumIpsum);
|
|
22
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/** A single block of MCP tool output. */
|
|
2
|
+
export interface WebmcpContent {
|
|
3
|
+
type: 'text';
|
|
4
|
+
text: string;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
/** The normalized shape every tool invocation resolves to. */
|
|
8
|
+
export interface WebmcpToolResult {
|
|
9
|
+
content: WebmcpContent[];
|
|
10
|
+
/** True when the tool was unknown or its handler threw. */
|
|
11
|
+
isError?: boolean;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/** Second argument handed to a tool handler. */
|
|
15
|
+
export interface WebmcpAgent {
|
|
16
|
+
requestUserInteraction<T>(callback: () => T | PromiseLike<T>): Promise<T>;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/** A tool as declared by the page. */
|
|
20
|
+
export interface WebmcpToolDescriptor {
|
|
21
|
+
name: string;
|
|
22
|
+
description?: string;
|
|
23
|
+
/** JSON Schema describing the handler's parameters. */
|
|
24
|
+
inputSchema?: Record<string, unknown>;
|
|
25
|
+
execute(params: Record<string, any>, agent: WebmcpAgent): unknown;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/** A tool as discovered by an agent — the descriptor without its handler. */
|
|
29
|
+
export type WebmcpToolSummary = Omit<WebmcpToolDescriptor, 'execute'>;
|
|
30
|
+
|
|
31
|
+
export interface ModelContext {
|
|
32
|
+
/** Adds one tool, leaving the rest of the registry intact. */
|
|
33
|
+
registerTool(tool: WebmcpToolDescriptor): void;
|
|
34
|
+
/** Removes one tool by name; returns whether it was present. */
|
|
35
|
+
unregisterTool(name: string): boolean;
|
|
36
|
+
/** Replaces the entire toolset. Validates before mutating. */
|
|
37
|
+
provideContext(config?: { tools?: WebmcpToolDescriptor[] }): void;
|
|
38
|
+
/** Non-standard: descriptors an agent would discover, minus handlers. */
|
|
39
|
+
readonly tools: WebmcpToolSummary[];
|
|
40
|
+
/** Non-standard: invokes a registered tool. Never rejects. */
|
|
41
|
+
callTool(name: string, params?: Record<string, unknown>): Promise<WebmcpToolResult>;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** Event name dispatched on `window` whenever the registry changes. */
|
|
45
|
+
export const TOOLS_CHANGED_EVENT: 'machvive-webmcp-change';
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Installs the polyfill. No-op when WebMCP is native or the page is not a
|
|
49
|
+
* secure context. Returns true only if this call installed it.
|
|
50
|
+
*/
|
|
51
|
+
export function installWebmcpPolyfill(): boolean;
|
|
52
|
+
|
|
53
|
+
export class MachviveWebmcpPolyfill extends HTMLElement {
|
|
54
|
+
registerTool(tool: WebmcpToolDescriptor): void;
|
|
55
|
+
unregisterTool(name: string): boolean | undefined;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
declare global {
|
|
59
|
+
interface Navigator {
|
|
60
|
+
/** Present on secure contexts; see `installWebmcpPolyfill`. */
|
|
61
|
+
modelContext: ModelContext;
|
|
62
|
+
}
|
|
63
|
+
interface HTMLElementTagNameMap {
|
|
64
|
+
'machvive-webmcp-polyfill': MachviveWebmcpPolyfill;
|
|
65
|
+
}
|
|
66
|
+
interface WindowEventMap {
|
|
67
|
+
'machvive-webmcp-change': CustomEvent<{ tools: WebmcpToolSummary[] }>;
|
|
68
|
+
}
|
|
69
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Polyfill for the WebMCP `navigator.modelContext` API.
|
|
3
|
+
*
|
|
4
|
+
* Mirrors the W3C Web Machine Learning CG proposal: registerTool / unregisterTool
|
|
5
|
+
* for incremental changes, provideContext to replace the whole toolset at once.
|
|
6
|
+
* https://webmachinelearning.github.io/webmcp/docs/proposal.html
|
|
7
|
+
*
|
|
8
|
+
* The polyfill is a registry only — it has no transport to an agent. Bridge code
|
|
9
|
+
* (an extension, a devtools panel, a harness) listens for `machvive-webmcp-change`
|
|
10
|
+
* on `window` and calls `navigator.modelContext.callTool(name, params)` to invoke.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
export const TOOLS_CHANGED_EVENT = 'machvive-webmcp-change';
|
|
14
|
+
|
|
15
|
+
function assertToolDescriptor(tool) {
|
|
16
|
+
if (!tool || typeof tool !== 'object') {
|
|
17
|
+
throw new TypeError('WebMCP: tool descriptor must be an object');
|
|
18
|
+
}
|
|
19
|
+
if (typeof tool.name !== 'string' || tool.name.length === 0) {
|
|
20
|
+
throw new TypeError('WebMCP: tool.name must be a non-empty string');
|
|
21
|
+
}
|
|
22
|
+
if (typeof tool.execute !== 'function') {
|
|
23
|
+
throw new TypeError(`WebMCP: tool "${tool.name}" must supply an execute() function`);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
// Handlers may return a bare string for convenience; the wire shape is always
|
|
28
|
+
// an MCP content array.
|
|
29
|
+
function normalizeResult(value) {
|
|
30
|
+
if (value && Array.isArray(value.content)) return value;
|
|
31
|
+
if (typeof value === 'string') return { content: [{ type: 'text', text: value }] };
|
|
32
|
+
if (value === undefined || value === null) return { content: [] };
|
|
33
|
+
return { content: [{ type: 'text', text: JSON.stringify(value) }] };
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
class ModelContextPolyfill {
|
|
37
|
+
#tools = new Map();
|
|
38
|
+
|
|
39
|
+
/** Adds one tool, leaving the rest of the registry intact. */
|
|
40
|
+
registerTool(tool) {
|
|
41
|
+
assertToolDescriptor(tool);
|
|
42
|
+
this.#tools.set(tool.name, tool);
|
|
43
|
+
this.#notify();
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** Removes one tool by name. Returns whether it was present. */
|
|
47
|
+
unregisterTool(name) {
|
|
48
|
+
const removed = this.#tools.delete(name);
|
|
49
|
+
if (removed) this.#notify();
|
|
50
|
+
return removed;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/** Replaces the entire toolset — use when app state changes what is available. */
|
|
54
|
+
provideContext({ tools = [] } = {}) {
|
|
55
|
+
tools.forEach(assertToolDescriptor);
|
|
56
|
+
this.#tools.clear();
|
|
57
|
+
for (const tool of tools) this.#tools.set(tool.name, tool);
|
|
58
|
+
this.#notify();
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** Non-standard: the descriptors an agent would discover, minus the handlers. */
|
|
62
|
+
get tools() {
|
|
63
|
+
return [...this.#tools.values()].map(({ name, description, inputSchema }) => ({
|
|
64
|
+
name,
|
|
65
|
+
description,
|
|
66
|
+
inputSchema
|
|
67
|
+
}));
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/** Non-standard: the invocation path a bridge uses to run a registered tool. */
|
|
71
|
+
async callTool(name, params = {}) {
|
|
72
|
+
const tool = this.#tools.get(name);
|
|
73
|
+
if (!tool) {
|
|
74
|
+
return { content: [{ type: 'text', text: `Unknown tool: ${name}` }], isError: true };
|
|
75
|
+
}
|
|
76
|
+
try {
|
|
77
|
+
return normalizeResult(await tool.execute(params, this.#agent()));
|
|
78
|
+
} catch (err) {
|
|
79
|
+
return { content: [{ type: 'text', text: String(err?.message ?? err) }], isError: true };
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
// The `agent` argument handed to execute(). Without a real agent channel the
|
|
84
|
+
// callback simply runs in the page, which is the correct degraded behavior.
|
|
85
|
+
#agent() {
|
|
86
|
+
return { requestUserInteraction: (callback) => Promise.resolve().then(callback) };
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
#notify() {
|
|
90
|
+
window.dispatchEvent(new CustomEvent(TOOLS_CHANGED_EVENT, { detail: { tools: this.tools } }));
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Installs the polyfill. No-op when the browser ships WebMCP natively, so a page
|
|
96
|
+
* always talks to the real implementation where one exists.
|
|
97
|
+
*
|
|
98
|
+
* @returns {boolean} true if this call installed the polyfill.
|
|
99
|
+
*/
|
|
100
|
+
export function installWebmcpPolyfill() {
|
|
101
|
+
if ('modelContext' in navigator) return false;
|
|
102
|
+
|
|
103
|
+
// The native API is [SecureContext]; matching that keeps http:// pages from
|
|
104
|
+
// developing against a surface the browser will never give them.
|
|
105
|
+
if (!window.isSecureContext) {
|
|
106
|
+
console.warn('WebMCP: navigator.modelContext is a secure-context API; polyfill not installed.');
|
|
107
|
+
return false;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
Object.defineProperty(navigator, 'modelContext', {
|
|
111
|
+
value: new ModelContextPolyfill(),
|
|
112
|
+
configurable: true,
|
|
113
|
+
enumerable: false,
|
|
114
|
+
writable: false
|
|
115
|
+
});
|
|
116
|
+
return true;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
export class MachviveWebmcpPolyfill extends HTMLElement {
|
|
120
|
+
constructor() {
|
|
121
|
+
super();
|
|
122
|
+
this.attachShadow({ mode: 'open' });
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
connectedCallback() {
|
|
126
|
+
installWebmcpPolyfill();
|
|
127
|
+
this.shadowRoot.innerHTML = `<style>:host { display: none; }</style>`;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
/** Convenience passthroughs so markup-driven pages need not reach into navigator. */
|
|
131
|
+
registerTool(tool) {
|
|
132
|
+
return navigator.modelContext?.registerTool(tool);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
unregisterTool(name) {
|
|
136
|
+
return navigator.modelContext?.unregisterTool(name);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// Installing on import (not just on upgrade) means tools can be registered before
|
|
141
|
+
// the element is parsed.
|
|
142
|
+
installWebmcpPolyfill();
|
|
143
|
+
|
|
144
|
+
if (!customElements.get('machvive-webmcp-polyfill')) {
|
|
145
|
+
customElements.define('machvive-webmcp-polyfill', MachviveWebmcpPolyfill);
|
|
146
|
+
}
|