Skip to content

Postman for MCPs - A tool for testing and debugging MCPs

License

Notifications You must be signed in to change notification settings

mozmo15/inspector-preview

Β 
Β 

Repository files navigation

MCPJam logo

MCPJam Inspectors test

npm version npm downloads Docker Pulls License: Apache 2.0 Node.js TypeScript Discord

MCPJam is a developer tool for testing and debugging Model Context Protocol (MCP) servers. It connects to any MCP server and allows you to manually test every part of your server. The project is open source and fully compliant to the MCP spec.

Main features are:

Features Description
All transports supported This inspector supports STDIO, SSE, and Streambable HTTP. Connect to any MCP server with environment variables and full authorization support.
Full MCP Spec Compliance The inspector has full compliance to the MCP spec. Test any MCP implementation in your server, like tools, prompts, resources, elicitation, authorization, and correct schemas.
Authorization Testing (OAuth 2.0) Support for Dynamic Client Registration (DCR) and the full OAuth 2.0 spec. Test your server's MCP token handling, authorization server implementation, and OAuth flow.
LLM Playground Test your MCP server against LLMs or custom agents. Has support for OpenAI, Anthropic, and Ollama models. Tweak agents' system prompts and temperature. Everything you need for MCP testing all in one platform.
Debugging tools Everything is logged including all of the error messages. This helps quickly debug your MCP server implementation.
Usability Save requests, multi-server connection, saved connections. CLI shortcuts to quickly spin up a testing environment.

πŸ“‹ Requirements

  • Node.js: ^22.7.5 or higher
  • npm: ^10.0.0 or higher (comes with Node.js)

Quick Start

Get up and running in seconds with the MCPJam Inspector:

npx @mcpjam/inspector@latest

That's it! The inspector will launch automatically in your browser at http://localhost:6274.

Running with Docker

You can also run the inspector using Docker. First, make sure you have Docker installed and running.

Pull the latest image from Docker Hub:

docker pull mcpjam/mcp-inspector:main

Then, run the container:

docker run --rm -p 6274:6274 -p 6277:6277 mcpjam/mcp-inspector:main

The inspector will be available in your browser at http://127.0.0.1:6274.


πŸ“Έ Screenshots

MCPJam Inspector Interface

🎯 Usage Examples

Basic Usage

# Launch inspector with default settings
npx @mcpjam/inspector

Connect to Local Server

# Connect to a server built at build/index.js
npx @mcpjam/inspector node build/index.js

Connect with Arguments

# Pass custom arguments to your server
npx @mcpjam/inspector node server.js --port 3000 --debug

Using Configuration File

# Load servers from a config file
npx @mcpjam/inspector --config ./my-config.json

Example Configuration File

{
  "mcpServers": {
    "my-awesome-server": {
      "command": "node",
      "args": ["build/index.js"],
      "env": {
        "API_KEY": "your-api-key",
        "DEBUG": "true"
      }
    },
    "python-server": {
      "command": "python",
      "args": ["-m", "my_mcp_server"],
      "env": {
        "PYTHONPATH": "./src"
      }
    }
  }
}

πŸ—οΈ Architecture

The MCPJam Inspector is built as a modern monorepo with three main components:

πŸ“¦ @mcpjam/inspector
β”œβ”€β”€ πŸ–₯️  client/     # React + TypeScript frontend
β”œβ”€β”€ πŸ”§  server/     # Express.js backend with WebSocket support
└── πŸš€  cli/        # Command-line interface

Tech Stack

  • Frontend: React 18, TypeScript, Tailwind CSS, Radix UI
  • Backend: Express.js, WebSocket (ws), CORS support
  • CLI: Node.js with shell integration
  • Build Tools: Vite, TSC, Concurrently

πŸ› οΈ Development

Local Development Setup

# Clone the repository
git clone https://github.com/mcpjam/inspector.git
cd inspector

# Install dependencies
npm install

# Start development servers
npm run dev

Build for Production

# Build all components
npm run build

# Test the build
npm run start

Scripts for development

We put together these commands to help you build locally:

Script Description
npm run dev Start development servers (client + server)
npm run build Build all components for production
npm run test Run test suite
npm run prettier-fix Format code with Prettier
npm run clean Clean all build artifacts and reinstall

🀝 Contributing

We welcome contributions! We thought the original inspector repository moved too slowly, so we wanted to build this project ourselves. Please read our CONTRIBUTING.md for more details.

  1. Clone the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ—ΊοΈ Our Roadmap

The community is working on MCPJam v1.0.0. We are on a mission to make MCPJam a production grade project. If you're interested, please read the design proposal. We're collaborating on this on Discord!

πŸ“š Resources


πŸ“„ License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.


Made with ❀️ by the MCPJam team

About

Postman for MCPs - A tool for testing and debugging MCPs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.0%
  • JavaScript 6.0%
  • Other 1.0%