From f2fd0e596ebdc4763def1630ef66c63486799478 Mon Sep 17 00:00:00 2001 From: Olivier Chafik Date: Mon, 24 Nov 2025 17:12:19 +0000 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b3e85a..163a8ff 100644 --- a/README.md +++ b/README.md @@ -33,16 +33,29 @@ What this repo does NOT provide: - There's no *supported* host implementation in this repo (beyond the [examples/simple-host](./examples/simple-host) example) - We have [contributed a tentative implementation](https://github.com/MCP-UI-Org/mcp-ui/pull/147) 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. -## Installation +## Using the SDK -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: +### Run examples + +Run the examples in this repo end-to-end: + +``` +npm i +npm start +open http://localhost:8080/ +``` + +> [!NOTE] +> Please bear with us while we add more examples! + +### Use the SDK in your project + +This repo is in flux and isn't published to npm (when it is, it will use the `@modelcontextprotocol/ext-apps` package). In the meantime you can depend on the SDK library in a Node.js project by installing it w/ its git URL: ```bash npm install git+https://github.com/modelcontextprotocol/ext-apps.git ``` -## Development Notes - ### Build tools in dependencies The build tools (`esbuild`, `tsx`, `typescript`) are in `dependencies` rather than `devDependencies`. This is intentional: it allows the `prepare` script to run when the package is installed from git, since npm doesn't install devDependencies for git dependencies.