Skip to content

Commit f2fd0e5

Browse files
committed
Update README.md
1 parent b77f68d commit f2fd0e5

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,29 @@ What this repo does NOT provide:
3333
- There's no *supported* host implementation in this repo (beyond the [examples/simple-host](./examples/simple-host) example)
3434
- 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.
3535

36-
## Installation
36+
## Using the SDK
3737

38-
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:
38+
### Run examples
39+
40+
Run the examples in this repo end-to-end:
41+
42+
```
43+
npm i
44+
npm start
45+
open http://localhost:8080/
46+
```
47+
48+
> [!NOTE]
49+
> Please bear with us while we add more examples!
50+
51+
### Use the SDK in your project
52+
53+
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:
3954

4055
```bash
4156
npm install git+https://github.com/modelcontextprotocol/ext-apps.git
4257
```
4358

44-
## Development Notes
45-
4659
### Build tools in dependencies
4760

4861
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.

0 commit comments

Comments
 (0)