From daa329b3bd28d83f1435f3ccaa88dc06798816dd Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Tue, 29 Oct 2024 14:22:19 +0000 Subject: [PATCH] README instructions for preinstalling the SDK --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 27406fd..835f671 100644 --- a/README.md +++ b/README.md @@ -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 ```