Skip to content

Update README instructions #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jspahrsummers merged 1 commit into from
Nov 20, 2024
Merged

Update README instructions #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

To run in production mode:
## License

```bash
npm run build
npm start
```
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.