Update README.md

This commit is contained in:
Olivier Chafik 2025-11-21 20:35:42 +00:00 • committed by GitHub
commit dd3c62947c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -7,13 +7,18 @@ MCP Apps are proposed standard inspired by [MCP-UI](https://mcpui.dev/) and [Ope
This repo provides:
- [types.ts](./src/types.ts): Types of JSON-RPC messages used to communicate between Apps & their host
- Note that MCP Apps also use some standard MCP messages (e.g. `tools/call` for the App to trigger actions on its originating Server - these calls are proxied through the Host), but these types are the additional messages defined by the extension
- [examples/simple-example](./examples/simple-example):
- [examples/simple-example](./examples/simple-example): Example Server + Apps
- [server.ts](./examples/simple-server/server.ts): MCP server with two tools that declare UI resources of Apps to be show in the chat when called
- [ui-react.tsx](./examples/simple-server/src/ui-react.tsx): React App returned by the `create-ui-react` tool shows how to use the `useApp` hook to register MCP callbacks
- [ui-vanilla.tsx](./examples/simple-server/src/ui-vanilla.ts): vanilla App returned by the `create-ui-vanilla`
- [main/specification/draft/apps.mdx](./main/specification/draft/apps.mdx): The Draft Extension Specification. It's still... in flux! Feedback welcome! (also see discussions in [SEP-1865](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/1865)).
- [message-transport](./src/message-transport.ts): `PostMessageTransport` class that uses `postMessage` to exchange JSON-RPC messages between windows / iframes
- [app.ts](./src/app.ts): `App` class used by an App to talk to its host
- [app-bridge.ts](./src/app-bridge.ts): `AppBridge` class used by the host to talk to a single App
What this repo does NOT provide: