Setup

Set up your development environment for MCPJam Inspector

Prerequisites

Make sure you have the following installed:

• Node.js (LTS version recommended)
• npm (comes with Node.js)

Quick Setup

1. Fork and clone the repository:

   git clone https://github.com/YOUR_USERNAME/inspector.git
   cd inspector
   

2. Install dependencies:

   npm install
   

3. Start development server:

   npm run dev
   

   For Windows users:

   npm run dev:windows
   

4. Open your browser to http://localhost:3000

Development Commands

• Run tests: npm test
• 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:

# 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

Remember to use -- when passing arguments through npm scripts: npm start -- --config file.json

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 for detailed guidelines
• Join our Discord for community support