Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions inspector/dev-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,28 @@ Make sure you have the following installed:
- **Format code**: `npm run prettier-fix`
- **Build project**: `npm run build`

## Testing with Config Files

When developing, you can test your changes with configuration files:

```bash
# Build first, then run with config
npm run build
npm start -- --config ../config.json --server everything

# Or run the CLI script directly
node bin/start.js --config ../config.json --server everything
```

<Warning>
Remember to use `--` when passing arguments through npm scripts: `npm start -- --config file.json`
</Warning>

This is useful for:
- Testing changes on a specific branch
- Validating configuration file handling
- Development workflow with multiple MCP servers

## Next Steps

- Check out our [Contributing Guide](/inspector/contributing-guide) for detailed guidelines
Expand Down
40 changes: 40 additions & 0 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,46 @@ This will open the MCPJam inspector and start an Ollama model with the `ollama s
npx @mcpjam/inspector@latest --ollama llama3.2
```

## Start with Configuration File

You can use a configuration file to connect to multiple MCP servers at once:

```bash
# Using npx directly
npx @mcpjam/inspector@latest --config path/to/config.json --server myserver

# If running from the repository
npm run build
npm start -- --config path/to/config.json --server myserver
```

<Info>
**Note**: When using `npm start`, you need the `--` separator to pass arguments to the underlying script.
</Info>

Example configuration file structure:

```json
{
"mcpServers": {
"everything": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-everything"],
"env": {
"HELLO": "Hello MCP!"
}
},
"weather-server": {
"command": "python",
"args": ["weather_server.py"],
"env": {
"WEATHER_API_KEY": "your-api-key"
}
}
}
}
```




Expand Down