Skip to content

Commit

Permalink
README instructions for preinstalling the SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
jspahrsummers committed Oct 29, 2024
1 parent 7926eea commit daa329b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down

0 comments on commit daa329b

Please sign in to comment.