Merge pull request #37 from modelcontextprotocol/justin/sdk-install-instructions

Instructions for installing the SDK dependency manually
This commit is contained in:
Justin Spahr-Summers 2024-10-29 19:57:02 +00:00 • committed by GitHub
commit 5427a6ec7c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,9 +2,16 @@
The MCP inspector is a developer tool for testing and debugging MCP servers.
Setup:
## Getting started
```bash
This repository depends on the [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk/). Until these repositories are made public and published to npm, the SDK has to be preinstalled manually:
1. Download the [latest release of the SDK](https://github.com/modelcontextprotocol/typescript-sdk/releases) (the file named something like `modelcontextprotocol-sdk-0.1.0.tgz`). You don't need to extract it.
2. From within your checkout of _this_ repository, run `npm install --save path/to/sdk.tgz`. This will overwrite the expected location for the SDK to allow you to proceed.
Then, you should be able to install the rest of the dependencies normally:
```sh
npm install
```