hzhang/inspector
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #67 from modelcontextprotocol/justin/update-readme

Browse Source 
Update README instructions
This commit is contained in:
Justin Spahr-Summers
2024-11-20 16:11:37 +00:00
committed by GitHub
parent f73770b143 232d5ffcf6
commit 03193a9dc4
1 changed files with 8 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -2,25 +2,18 @@
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:
```sh
npm install
```
npx @modelcontextprotocol/inspector build/index.js
```
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:
```bash
npm run build
npm start
```
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.