|
1 | 1 | # @modelcontextprotocol/ext-apps |
2 | 2 |
|
3 | | -This repo contains the SDK and [specification](https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx) for MCP Apps Extension ([SEP-1865](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/1865)). |
| 3 | +This repo contains the SDK and [specification](./main/specification/draft/apps.mdx) for MCP Apps Extension ([SEP-1865](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/1865)). |
4 | 4 |
|
5 | 5 | MCP Apps are a standard inspired by [OpenAI's Apps SDK](https://developers.openai.com/apps-sdk/) and [MCP-UI](https://mcpui.dev/) to allow MCP Servers to display interactive UI elements in conversational MCP clients / chatbots. |
6 | 6 |
|
| 7 | +This repo provides: |
| 8 | +- [types.ts](./src/types.ts): Types of JSON-RPC messages used to communicate between Apps & their host |
| 9 | + - 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 |
| 10 | +- [examples/simple-example](./examples/simple-example): |
| 11 | + - [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 |
| 12 | + - [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 |
| 13 | + - [ui-vanilla.tsx](./examples/simple-server/src/ui-vanilla.ts): vanilla App returned by the `create-ui-vanilla` |
| 14 | +- [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)). |
| 15 | +- [message-transport](./src/message-transport.ts): `PostMessageTransport` class that uses `postMessage` to exchange JSON-RPC messages between windows / iframes |
| 16 | +- [app.ts](./src/app.ts): `App` class used by an App to talk to its host |
| 17 | +- [app-bridge.ts](./src/app-bridge.ts): `AppBridge` class used by the host to talk to a single App |
| 18 | + |
| 19 | +What this repo does NOT provide: |
| 20 | +- There's no host implementation here (beyond the `AppBridge` just used for communications). |
| 21 | + - We have contributed a tentative implementation of hosting / iframing / sandboxing logic to the [MCP-UI](https://github.com/idosal/mcp-ui) repository, and expect OSS clients may use it, while other clients might roll their own hosting logic. |
| 22 | + - A prior iteration of an e2e prototype w/ client, server and hosting parts is available [in this gist](https://gist.github.com/ochafik/a9603ba2d6757d6038ce066eded4c354) |
| 23 | + |
7 | 24 | ## Installation |
8 | 25 |
|
9 | | -This repo is in flux and isn't published to npm (when it is, we'll probably use the `@modelcontextprotocol/ext-apps` package). Please install it from git for now: |
| 26 | +This repo is in flux and isn't published to npm (when it is, it will use the `@modelcontextprotocol/ext-apps` package). Please install it from git for now: |
10 | 27 |
|
11 | 28 | ```bash |
12 | 29 | npm install git+https://github.com/modelcontextprotocol/ext-apps.git |
|
0 commit comments