You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To build specifically this package from the monorepo root:
178
-
179
197
```bash
180
198
pnpm build -w @mcp-ui/client
181
199
```
@@ -184,7 +202,9 @@ See the following pages for more details:
184
202
185
203
## Basic Setup
186
204
187
-
For MCP servers, ensure you have `@mcp-ui/server` available in your Node.js project. If you're working outside this monorepo, you would typically install them.
205
+
For MCP servers, you can use one of the server-side SDKs:
206
+
-**`@mcp-ui/server`** for Node.js projects
207
+
-**`mcp_ui_server`** for Ruby projects
188
208
189
209
For MCP clients, ensure `@mcp-ui/client` and its peer dependencies (`react` and potentially `@modelcontextprotocol/sdk`) are installed in your React project.
190
210
@@ -194,11 +214,14 @@ npm i @mcp-ui/client
194
214
195
215
## Key Components
196
216
197
-
### Server Side (`@mcp-ui/server`)
198
-
- **`createUIResource`**: Creates UI resource objects for MCP tool responses
217
+
### Server-Side SDKs
218
+
-**`@mcp-ui/server` (TypeScript)**:
219
+
-**`createUIResource`**: Creates UI resource objects for MCP tool responses
220
+
-**`mcp_ui_server` (Ruby)**:
221
+
-**`McpUiServer.create_ui_resource`**: Creates UI resource objects for MCP tool responses
199
222
- Handles HTML content, external URLs, Remote DOM JS, and encoding options
200
223
201
-
### ClientSide (`@mcp-ui/client`)
224
+
### Client-Side (`@mcp-ui/client`)
202
225
-**`<UIResourceRenderer />`**: Main component for rendering all types of MCP-UI resources
203
226
-**`<HTMLResourceRenderer />`**: Internal component for HTML resources
204
227
-**`<RemoteDOMResourceRenderer />`**: Internal component for Remote DOM resources
@@ -223,3 +246,4 @@ All resource types are handled automatically by `<UIResourceRenderer />`.
0 commit comments