Skip to content

installation.mdx

Latest commit

 

History

History
77 lines (51 loc) · 1.71 KB

installation.mdx

File metadata and controls

77 lines (51 loc) · 1.71 KB
Raw
title Installation
description Here's a list of all ways to start MCPJam
icon terminal

Quick start

Run the command in your terminal

```bash
npx @mcpjam/inspector@latest
```

After installing the package, you should see a link to localhost. Open that link up to see the inspector.

Docker

Run MCPJam Inspector using Docker:

# Run the latest version from Docker Hub
docker run -p 3001:3001 mcpjam/mcp-inspector:latest

# Or run in the background
docker run -d -p 3001:3001 --name mcp-inspector mcpjam/mcp-inspector:latest

The application will be available at http://localhost:3001.

Start with STDIO server

This will open the MCPJam inspector and connect to a STDIO using the commands you provided.

```bash # Starts MCPJam inspector with a FastMCP server npx @mcpjam/inspector@latest uv run fastmcp run /path/to/your/server.py ``` ```bash # NPX package npx @mcpjam/inspector@latest npx -y your-mcp-package 
# Direct Node.js execution
npx @mcpjam/inspector@latest node /path/to/your/server.js
```
**Use Absolute Paths**: Always use absolute file paths (e.g., `/Users/yourname/project/server.py`) to avoid path resolution issues.

Start with custom port

This will start the MCPJam inspector with a custom port number. The default port is 6274.

npx @mcpjam/inspector@latest --port 4000

Start with Ollama

This will open the MCPJam inspector and start an Ollama model with the ollama serve <model> command. Make sure you have Ollama installed.

npx @mcpjam/inspector@latest --ollama llama3.2