Update README instructions

This commit is contained in:
Justin Spahr-Summers
2024-11-20 14:48:02 +00:00
parent 676de45bab
commit 232d5ffcf6

View File

@@ -2,25 +2,18 @@
The MCP inspector is a developer tool for testing and debugging MCP servers. The MCP inspector is a developer tool for testing and debugging MCP servers.
## Getting started It can be run easily from `npx`. For example, in a folder where there's a built JavaScript server at `build/index.js`:
Clone this repository, then install its dependencies: ```
npx @modelcontextprotocol/inspector build/index.js
```sh
npm install
``` ```
You can run it in dev mode via: You can also pass arguments along to the server:
```bash ```
npm run dev npx @modelcontextprotocol/inspector build/index.js arg1 arg2 ...
``` ```
This will start both the client and server. ## License
To run in production mode: This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.
```bash
npm run build
npm start
```