@mcp-web/react 0.1.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 +201 -0
- package/README.md +180 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp-web-context.d.ts +16 -0
- package/dist/mcp-web-context.d.ts.map +1 -0
- package/dist/mcp-web-context.js +7 -0
- package/dist/mcp-web-context.js.map +1 -0
- package/dist/mcp-web-provider.d.ts +62 -0
- package/dist/mcp-web-provider.d.ts.map +1 -0
- package/dist/mcp-web-provider.js +54 -0
- package/dist/mcp-web-provider.js.map +1 -0
- package/dist/use-apps.d.ts +63 -0
- package/dist/use-apps.d.ts.map +1 -0
- package/dist/use-apps.js +58 -0
- package/dist/use-apps.js.map +1 -0
- package/dist/use-connected-mcp-web.d.ts +14 -0
- package/dist/use-connected-mcp-web.d.ts.map +1 -0
- package/dist/use-connected-mcp-web.js +44 -0
- package/dist/use-connected-mcp-web.js.map +1 -0
- package/dist/use-mcp-apps.d.ts +63 -0
- package/dist/use-mcp-apps.d.ts.map +1 -0
- package/dist/use-mcp-apps.js +58 -0
- package/dist/use-mcp-apps.js.map +1 -0
- package/dist/use-mcp-tools.d.ts +99 -0
- package/dist/use-mcp-tools.d.ts.map +1 -0
- package/dist/use-mcp-tools.js +90 -0
- package/dist/use-mcp-tools.js.map +1 -0
- package/dist/use-mcp-web.d.ts +18 -0
- package/dist/use-mcp-web.d.ts.map +1 -0
- package/dist/use-mcp-web.js +25 -0
- package/dist/use-mcp-web.js.map +1 -0
- package/dist/use-tools.d.ts +78 -0
- package/dist/use-tools.d.ts.map +1 -0
- package/dist/use-tools.js +64 -0
- package/dist/use-tools.js.map +1 -0
- package/package.json +31 -0
- package/src/index.ts +5 -0
- package/src/mcp-web-context.ts +18 -0
- package/src/mcp-web-provider.ts +87 -0
- package/src/use-connected-mcp-web.ts +49 -0
- package/src/use-mcp-apps.ts +141 -0
- package/src/use-mcp-tools.ts +221 -0
- package/src/use-mcp-web.ts +25 -0
- package/tsconfig.json +10 -0
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 2025 Fritz Lekschas
|
|
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,180 @@
|
|
|
1
|
+
# @mcp-web/react
|
|
2
|
+
|
|
3
|
+
Expose React component state as MCP tools so Claude can read and write your UI state.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @mcp-web/react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
*Requires `react` to be installed in your project.*
|
|
12
|
+
|
|
13
|
+
## Basic Usage
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MCPWebProvider, useTool } from '@mcp-web/react';
|
|
17
|
+
import { useState } from 'react';
|
|
18
|
+
import { z } from 'zod';
|
|
19
|
+
|
|
20
|
+
function Root() {
|
|
21
|
+
return (
|
|
22
|
+
<MCPWebProvider config={{ name: 'My App', description: 'My application' }}>
|
|
23
|
+
<MyComponent />
|
|
24
|
+
</MCPWebProvider>
|
|
25
|
+
);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
function MyComponent() {
|
|
29
|
+
// Your React state
|
|
30
|
+
const [filterText, setFilterText] = useState('');
|
|
31
|
+
const [viewMode, setViewMode] = useState('grid');
|
|
32
|
+
|
|
33
|
+
// Expose state as read-write MCP tools
|
|
34
|
+
// No need to pass mcpWeb - it's automatically accessed from context!
|
|
35
|
+
useTool({
|
|
36
|
+
name: 'filter_text',
|
|
37
|
+
description: 'Text filter for searching items',
|
|
38
|
+
value: filterText,
|
|
39
|
+
setValue: setFilterText,
|
|
40
|
+
valueSchema: z.string(),
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
useTool({
|
|
44
|
+
name: 'view_mode',
|
|
45
|
+
description: 'Current display mode',
|
|
46
|
+
value: viewMode,
|
|
47
|
+
setValue: setViewMode,
|
|
48
|
+
valueSchema: z.enum(['grid', 'list', 'card']),
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
return <div>Your component UI...</div>;
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Complex State Objects
|
|
56
|
+
|
|
57
|
+
For large object state, you can use schema splitting:
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
const [userPreferences, setUserPreferences] = useState({
|
|
61
|
+
theme: 'light',
|
|
62
|
+
notifications: { email: true, push: false },
|
|
63
|
+
display: { compact: false, animations: true }
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
const preferencesSchema = z.object({
|
|
67
|
+
theme: z.enum(['light', 'dark']),
|
|
68
|
+
notifications: z.object({
|
|
69
|
+
email: z.boolean(),
|
|
70
|
+
push: z.boolean()
|
|
71
|
+
}),
|
|
72
|
+
display: z.object({
|
|
73
|
+
compact: z.boolean(),
|
|
74
|
+
animations: z.boolean()
|
|
75
|
+
})
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
useTool({
|
|
79
|
+
name: 'user_preferences',
|
|
80
|
+
description: 'User interface preferences',
|
|
81
|
+
value: userPreferences,
|
|
82
|
+
setValue: setUserPreferences,
|
|
83
|
+
valueSchema: preferencesSchema,
|
|
84
|
+
// Expose the user preferences as three MCP tools. One for theme,
|
|
85
|
+
// notifications, and display settings each.
|
|
86
|
+
valueSchemaSplit: ['theme', 'notifications', 'display'],
|
|
87
|
+
});
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
This creates multiple MCP tools:
|
|
91
|
+
- `set_user_preferences_theme` - Set theme
|
|
92
|
+
- `set_user_preferences_notifications` - Set notification settings
|
|
93
|
+
- `set_user_preferences_display` - Set display options
|
|
94
|
+
|
|
95
|
+
## Read-Only State
|
|
96
|
+
|
|
97
|
+
For read-only state, omit the `setValue` prop:
|
|
98
|
+
|
|
99
|
+
```typescript
|
|
100
|
+
useTool({
|
|
101
|
+
name: 'project_statistics',
|
|
102
|
+
description: 'Current project statistics',
|
|
103
|
+
value: calculateStats(), // Function that returns current stats
|
|
104
|
+
valueSchema: statsSchema,
|
|
105
|
+
// No setValue - this becomes read-only
|
|
106
|
+
});
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## Advanced: Manual MCPWeb Instance
|
|
110
|
+
|
|
111
|
+
If you need manual control over the MCPWeb instance, you can pass it explicitly:
|
|
112
|
+
|
|
113
|
+
```typescript
|
|
114
|
+
import { MCPWeb } from '@mcp-web/core';
|
|
115
|
+
import { useTool } from '@mcp-web/react';
|
|
116
|
+
|
|
117
|
+
const mcpWeb = new MCPWeb({ name: 'My App' });
|
|
118
|
+
|
|
119
|
+
function MyComponent() {
|
|
120
|
+
const [state, setState] = useState('');
|
|
121
|
+
|
|
122
|
+
useTool({
|
|
123
|
+
mcpWeb, // Explicit instance (optional when using MCPWebProvider)
|
|
124
|
+
name: 'state',
|
|
125
|
+
description: 'My state',
|
|
126
|
+
value: state,
|
|
127
|
+
setValue: setState,
|
|
128
|
+
valueSchema: z.string(),
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## API Reference
|
|
134
|
+
|
|
135
|
+
### `MCPWebProvider`
|
|
136
|
+
|
|
137
|
+
Provider component that creates and manages the MCPWeb instance.
|
|
138
|
+
|
|
139
|
+
**Props:**
|
|
140
|
+
- `config` - MCPWeb configuration object
|
|
141
|
+
- `name` - Application name
|
|
142
|
+
- `description` - Application description
|
|
143
|
+
- Other MCPWeb config options
|
|
144
|
+
- `children` - React components
|
|
145
|
+
|
|
146
|
+
### `useMCPWeb()`
|
|
147
|
+
|
|
148
|
+
Hook to access the MCPWeb instance and connection state from context.
|
|
149
|
+
|
|
150
|
+
**Returns:**
|
|
151
|
+
- `mcpWeb` - The MCPWeb instance
|
|
152
|
+
- `isConnected` - Boolean indicating connection status
|
|
153
|
+
|
|
154
|
+
**Example:**
|
|
155
|
+
```typescript
|
|
156
|
+
function MyComponent() {
|
|
157
|
+
const { mcpWeb, isConnected } = useMCPWeb();
|
|
158
|
+
|
|
159
|
+
if (!isConnected) {
|
|
160
|
+
return <div>Connecting to MCP bridge...</div>;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
// Use mcpWeb...
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### `useTool(config)`
|
|
168
|
+
|
|
169
|
+
Register state as MCP tools.
|
|
170
|
+
|
|
171
|
+
**Config:**
|
|
172
|
+
- `mcpWeb` *(optional)* - MCPWeb instance (auto-detected from context)
|
|
173
|
+
- `name` - Tool name
|
|
174
|
+
- `description` - Tool description
|
|
175
|
+
- `value` - Current state value
|
|
176
|
+
- `setValue` *(optional)* - State setter function (omit for read-only)
|
|
177
|
+
- `valueSchema` - Zod schema for validation
|
|
178
|
+
- `valueSchemaSplit` *(optional)* - Split complex objects into multiple tools
|
|
179
|
+
|
|
180
|
+
The hook automatically handles tool registration/cleanup on mount/unmount.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export type { MCPWebContextValue } from './mcp-web-context';
|
|
2
|
+
export { MCPWebProvider, type MCPWebProviderProps, type MCPWebProviderPropsWithConfig, type MCPWebProviderPropsWithInstance } from './mcp-web-provider';
|
|
3
|
+
export { useMCPWeb } from './use-mcp-web';
|
|
4
|
+
export { useMCPTools, type RegisterableTool, type UseMCPToolsOptions } from './use-mcp-tools';
|
|
5
|
+
export { useMCPApps, type RegisterableApp } from './use-mcp-apps';
|
|
6
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,KAAK,mBAAmB,EAAE,KAAK,6BAA6B,EAAE,KAAK,+BAA+B,EAAE,MAAM,oBAAoB,CAAC;AACxJ,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAsG,MAAM,oBAAoB,CAAC;AACxJ,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAkD,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAE,UAAU,EAAwB,MAAM,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { MCPWeb } from "@mcp-web/core";
|
|
2
|
+
/**
|
|
3
|
+
* Context value provided by MCPWebProvider.
|
|
4
|
+
*/
|
|
5
|
+
export interface MCPWebContextValue {
|
|
6
|
+
/** The MCPWeb instance for registering tools and making queries. */
|
|
7
|
+
mcpWeb: MCPWeb;
|
|
8
|
+
/** Whether the MCPWeb instance is connected to the bridge server. */
|
|
9
|
+
isConnected: boolean;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* React context for sharing MCPWeb instance across component tree.
|
|
13
|
+
* @internal Use MCPWebProvider and useMCPWeb instead of accessing directly.
|
|
14
|
+
*/
|
|
15
|
+
export declare const MCPWebContext: import("react").Context<MCPWebContextValue | null>;
|
|
16
|
+
//# sourceMappingURL=mcp-web-context.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mcp-web-context.d.ts","sourceRoot":"","sources":["../src/mcp-web-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAG5C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,oDAAiD,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { createContext } from "react";
|
|
2
|
+
/**
|
|
3
|
+
* React context for sharing MCPWeb instance across component tree.
|
|
4
|
+
* @internal Use MCPWebProvider and useMCPWeb instead of accessing directly.
|
|
5
|
+
*/
|
|
6
|
+
export const MCPWebContext = createContext(null);
|
|
7
|
+
//# sourceMappingURL=mcp-web-context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mcp-web-context.js","sourceRoot":"","sources":["../src/mcp-web-context.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAYtC;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,aAAa,CAA4B,IAAI,CAAC,CAAC"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { MCPWeb } from "@mcp-web/core";
|
|
2
|
+
import type { MCPWebConfig } from "@mcp-web/types";
|
|
3
|
+
import React, { type ReactNode } from "react";
|
|
4
|
+
/**
|
|
5
|
+
* Props for MCPWebProvider when creating a new MCPWeb instance from config.
|
|
6
|
+
*/
|
|
7
|
+
export interface MCPWebProviderPropsWithConfig {
|
|
8
|
+
/** Child components that can access MCPWeb via useMCPWeb hook. */
|
|
9
|
+
children: ReactNode;
|
|
10
|
+
/** Configuration for creating a new MCPWeb instance. */
|
|
11
|
+
config: MCPWebConfig;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Props for MCPWebProvider when using an existing MCPWeb instance.
|
|
15
|
+
*/
|
|
16
|
+
export interface MCPWebProviderPropsWithInstance {
|
|
17
|
+
/** Child components that can access MCPWeb via useMCPWeb hook. */
|
|
18
|
+
children: ReactNode;
|
|
19
|
+
/** Existing MCPWeb instance to provide to children. */
|
|
20
|
+
mcpWeb: MCPWeb;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Props for MCPWebProvider component.
|
|
24
|
+
* Either provide a `config` to create a new instance, or `mcpWeb` to use an existing one.
|
|
25
|
+
*/
|
|
26
|
+
export type MCPWebProviderProps = MCPWebProviderPropsWithConfig | MCPWebProviderPropsWithInstance;
|
|
27
|
+
/**
|
|
28
|
+
* Provider component that shares an MCPWeb instance across the component tree.
|
|
29
|
+
*
|
|
30
|
+
* Handles MCPWeb instantiation (if config provided) and connection lifecycle
|
|
31
|
+
* automatically. All child components can access the MCPWeb instance via the
|
|
32
|
+
* `useMCPWeb` hook.
|
|
33
|
+
*
|
|
34
|
+
* @example With config (creates new instance)
|
|
35
|
+
* ```tsx
|
|
36
|
+
* function Root() {
|
|
37
|
+
* return (
|
|
38
|
+
* <MCPWebProvider config={{
|
|
39
|
+
* name: 'My App',
|
|
40
|
+
* description: 'My app description',
|
|
41
|
+
* }}>
|
|
42
|
+
* <App />
|
|
43
|
+
* </MCPWebProvider>
|
|
44
|
+
* );
|
|
45
|
+
* }
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @example With existing instance
|
|
49
|
+
* ```tsx
|
|
50
|
+
* const mcpWeb = new MCPWeb(config);
|
|
51
|
+
*
|
|
52
|
+
* function Root() {
|
|
53
|
+
* return (
|
|
54
|
+
* <MCPWebProvider mcpWeb={mcpWeb}>
|
|
55
|
+
* <App />
|
|
56
|
+
* </MCPWebProvider>
|
|
57
|
+
* );
|
|
58
|
+
* }
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
export declare function MCPWebProvider({ children, ...props }: MCPWebProviderProps): React.FunctionComponentElement<React.ProviderProps<import("./mcp-web-context").MCPWebContextValue | null>>;
|
|
62
|
+
//# sourceMappingURL=mcp-web-provider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mcp-web-provider.d.ts","sourceRoot":"","sources":["../src/mcp-web-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,EAAE,KAAK,SAAS,EAAW,MAAM,OAAO,CAAC;AAIvD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,kEAAkE;IAClE,QAAQ,EAAE,SAAS,CAAC;IACpB,wDAAwD;IACxD,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,kEAAkE;IAClE,QAAQ,EAAE,SAAS,CAAC;IACpB,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,6BAA6B,GAAG,+BAA+B,CAAC;AAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,cAAc,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,EAAE,mBAAmB,8GAoBzE"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { MCPWeb } from "@mcp-web/core";
|
|
2
|
+
import React, { useMemo } from "react";
|
|
3
|
+
import { MCPWebContext } from "./mcp-web-context";
|
|
4
|
+
import { useConnectedMCPWeb } from "./use-connected-mcp-web";
|
|
5
|
+
/**
|
|
6
|
+
* Provider component that shares an MCPWeb instance across the component tree.
|
|
7
|
+
*
|
|
8
|
+
* Handles MCPWeb instantiation (if config provided) and connection lifecycle
|
|
9
|
+
* automatically. All child components can access the MCPWeb instance via the
|
|
10
|
+
* `useMCPWeb` hook.
|
|
11
|
+
*
|
|
12
|
+
* @example With config (creates new instance)
|
|
13
|
+
* ```tsx
|
|
14
|
+
* function Root() {
|
|
15
|
+
* return (
|
|
16
|
+
* <MCPWebProvider config={{
|
|
17
|
+
* name: 'My App',
|
|
18
|
+
* description: 'My app description',
|
|
19
|
+
* }}>
|
|
20
|
+
* <App />
|
|
21
|
+
* </MCPWebProvider>
|
|
22
|
+
* );
|
|
23
|
+
* }
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @example With existing instance
|
|
27
|
+
* ```tsx
|
|
28
|
+
* const mcpWeb = new MCPWeb(config);
|
|
29
|
+
*
|
|
30
|
+
* function Root() {
|
|
31
|
+
* return (
|
|
32
|
+
* <MCPWebProvider mcpWeb={mcpWeb}>
|
|
33
|
+
* <App />
|
|
34
|
+
* </MCPWebProvider>
|
|
35
|
+
* );
|
|
36
|
+
* }
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
export function MCPWebProvider({ children, ...props }) {
|
|
40
|
+
const mcpWeb = 'mcpWeb' in props ? props.mcpWeb : undefined;
|
|
41
|
+
const config = 'config' in props ? props.config : undefined;
|
|
42
|
+
const mcpInstance = useMemo(() => {
|
|
43
|
+
if (mcpWeb) {
|
|
44
|
+
return mcpWeb;
|
|
45
|
+
}
|
|
46
|
+
if (config) {
|
|
47
|
+
return new MCPWeb(config);
|
|
48
|
+
}
|
|
49
|
+
throw new Error('MCPWebProvider requires either mcpWeb or config prop');
|
|
50
|
+
}, [mcpWeb, config]);
|
|
51
|
+
const mcpState = useConnectedMCPWeb(mcpInstance);
|
|
52
|
+
return React.createElement(MCPWebContext.Provider, { value: mcpState }, children);
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=mcp-web-provider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mcp-web-provider.js","sourceRoot":"","sources":["../src/mcp-web-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,OAAO,KAAK,EAAE,EAAkB,OAAO,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AA4B7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,cAAc,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAuB;IACxE,MAAM,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,MAAM,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAE5D,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE;QAC/B,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACrB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAEjD,OAAO,KAAK,CAAC,aAAa,CACxB,aAAa,CAAC,QAAQ,EACtB,EAAE,KAAK,EAAE,QAAQ,EAAE,EACnB,QAAQ,CACT,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import type { MCPWeb } from '@mcp-web/core';
|
|
2
|
+
import type { AppDefinition, CreatedApp } from '@mcp-web/types';
|
|
3
|
+
/**
|
|
4
|
+
* An app that can be registered with useApps.
|
|
5
|
+
* Can be a CreatedApp or a raw AppDefinition.
|
|
6
|
+
*/
|
|
7
|
+
export type RegisterableApp = CreatedApp | AppDefinition;
|
|
8
|
+
/**
|
|
9
|
+
* Hook for registering MCP Apps with automatic cleanup on unmount.
|
|
10
|
+
*
|
|
11
|
+
* This is the recommended way to register MCP Apps in React applications.
|
|
12
|
+
* Apps are registered when the component mounts and automatically
|
|
13
|
+
* unregistered when the component unmounts.
|
|
14
|
+
*
|
|
15
|
+
* MCP Apps are visual UI components that AI can render inline in chat
|
|
16
|
+
* interfaces like Claude Desktop.
|
|
17
|
+
*
|
|
18
|
+
* @example Basic usage with createApp
|
|
19
|
+
* ```tsx
|
|
20
|
+
* // apps.ts
|
|
21
|
+
* import { createApp } from '@mcp-web/app';
|
|
22
|
+
*
|
|
23
|
+
* export const statisticsApp = createApp({
|
|
24
|
+
* name: 'show_statistics',
|
|
25
|
+
* description: 'Display statistics visualization',
|
|
26
|
+
* handler: () => ({
|
|
27
|
+
* totalTasks: todos.length,
|
|
28
|
+
* completedTasks: completedTodos.length,
|
|
29
|
+
* }),
|
|
30
|
+
* });
|
|
31
|
+
*
|
|
32
|
+
* // App.tsx
|
|
33
|
+
* import { useApps } from '@mcp-web/react';
|
|
34
|
+
* import { statisticsApp } from './apps';
|
|
35
|
+
*
|
|
36
|
+
* function App() {
|
|
37
|
+
* useApps(statisticsApp);
|
|
38
|
+
* return <div>...</div>;
|
|
39
|
+
* }
|
|
40
|
+
* ```
|
|
41
|
+
*
|
|
42
|
+
* @example Multiple apps
|
|
43
|
+
* ```tsx
|
|
44
|
+
* function App() {
|
|
45
|
+
* useApps(statisticsApp, chartApp, dashboardApp);
|
|
46
|
+
* return <div>...</div>;
|
|
47
|
+
* }
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @example Conditional app registration
|
|
51
|
+
* ```tsx
|
|
52
|
+
* function Analytics() {
|
|
53
|
+
* // This app only exists while Analytics is mounted
|
|
54
|
+
* useApps(analyticsApp);
|
|
55
|
+
* return <div>Analytics enabled</div>;
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param apps - Apps to register (variadic or array)
|
|
60
|
+
*/
|
|
61
|
+
export declare function useApps(...apps: (RegisterableApp | RegisterableApp[])[]): void;
|
|
62
|
+
export declare function useApps(mcpWeb: MCPWeb, ...apps: (RegisterableApp | RegisterableApp[])[]): void;
|
|
63
|
+
//# sourceMappingURL=use-apps.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-apps.d.ts","sourceRoot":"","sources":["../src/use-apps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAKhE;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,aAAa,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,wBAAgB,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC;AAEhF,wBAAgB,OAAO,CACrB,MAAM,EAAE,MAAM,EACd,GAAG,IAAI,EAAE,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,GAC/C,IAAI,CAAC"}
|