Getting Started - MCPJam Inspector
https://docs.mcpjam.com/getting-started • 345 KB fetched Open original page
Getting Started - MCPJam Inspector
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Skip to main content
MCPJam Inspector home page
Search...
⌘ K
* Discord
* GitHub
* Website
*
MCPJam
*
Getting Started
*
Installation
*
Hosted App
*
Slack
*
Okta SSO & SCIM
*
GitHub Checks
*
Common MCP Errors
*
Error code reference
* Changelog
* GitHub
*
Get Started
Inspector
CLI
SDK
API
MCPJam Inspector home page
Search...
⌘ K Ask Assistant ⌘ I
* GitHub
Search...
Navigation
Getting Started
Get Started
Inspector
CLI
SDK
API
Getting Started
Copy page Copy page
Start testing your MCP server in minutes
Copy page Copy page
1. Open MCPJam
Web : HTTPS only, runs in the browser with no install. Share server links with teammates. Terminal and Desktop : HTTP/S and local STDIO.
Web App
HTTPS only. No install. Share with your team.
Terminal
npx @mcpjam/inspector@latest . HTTP/S and local STDIO.
Desktop App
Mac or Windows. HTTP/S and local STDIO.
2. Draw something
On first launch, MCPJam connects the Excalidraw sample server (diagramming MCP app) and opens the Playground with this prompt:
Draw me an MCP architecture diagram
Press Send . The diagram renders in the app: tool call, then widget, then inspect. No API key, ngrok, or ChatGPT/Claude subscription needed.
You should see a tool call to create_view followed by a rendered diagram inline in the chat. If you don’t, check that the Excalidraw server shows Connected in the Connect tab.
Use the widget debug icons to open tool input/output, CSP activity, widget state, and JSON-RPC for that result.
3. Connect your own server
Open the Connect tab in the left sidebar (labelled Servers in some builds). Click Add server .
* HTTP : Paste a URL ending in /mcp . The web app accepts HTTPS URLs only. Desktop and Terminal accept HTTP or HTTPS . Add a bearer token or use the OAuth Debugger if the server requires auth.
* STDIO (Desktop and Terminal only): Paste a command such as npx -y @modelcontextprotocol/server-everything . Not available in the web app. See Hosted App .
Each Connected server is available in the Playground, Tools, Prompts, and Resources. Connect more from the Connect tab anytime.
You should see your server show Connected with a green dot in the Connect tab, and its tools should appear in the Playground’s left rail.
4. Where to go next
Playground
IDE-style workspace for developing against your MCP servers. Chat with frontier models, invoke tools by hand, render OpenAI Apps SDK and MCP app widgets, and inspect every step via Chat / Trace / Raw. Compare up to 3 models side by side; debug widgets with the emulator (iframe, window.openai , CSP, device frames, locale).
OAuth Debugger
Step through your MCP authorization flow and inspect each stage. Check conformance across protocol versions (03-26, 06-18, 11-25) and client registration paths: Dynamic Client Registration (DCR), client pre-registration, and CIMD.
Projects
Group servers; share configuration with your team
API keys
The three things called “API key” in MCPJam (LLM provider key, MCPJAM_API_KEY , per-server bearer) and when you need each one.
FAQ
Does MCPJam need a database?
No. MCPJam Inspector runs as a hosted web app, a desktop app, or via npx — none of them require you to install or configure a database. Accounts, sharing, and OAuth token storage on app.mcpjam.com are handled by the hosted backend; the Terminal and Desktop apps store config locally on disk.
How do I check which version of Inspector I'm running?
All three installs (Web, Desktop, Terminal) show the running version in the Settings tab under About . To see the latest published version on npm, run this. It’s useful for confirming an @latest pull actually moved you forward:
npm view @mcpjam/inspector version
The Desktop and Web apps update on their own. For the Terminal install, the @latest tag in npx @mcpjam/inspector@latest pulls the most recent release every run.
Can MCPJam auto-install MCP servers into my repo?
Not directly. MCPJam doesn’t reach into your repo. The closest workflow is Skills : install the MCPJam CLI skill into a project so an agent working in that repo knows how to use MCP tools and call MCPJam against your servers. See Skills .
Where are my files saved?
It depends what you mean. The word covers three different things:
* OAuth credentials from mcpjam oauth login : ~/.mcpjam/config.json . Override per command with --credentials-out . See CLI OAuth login .
* Eval results : uploaded to your MCPJam project when MCPJAM_API_KEY is set to an MCPJam API key ( sk_… ). See Saving Results .
* Inspector UI changes (server config, client edits): persisted via the Save button in the project view.
How do I sign out of the hosted app?
Open the account menu at the bottom of the sidebar and pick Sign out . You’ll be returned to the public app as a guest. See Hosted App → Signing out .
Was this page helpful?
Yes No
Previous Installation
Here's a list of all ways to start MCPJam
Next
⌘ I
discord github website linkedin x
Powered by This documentation is built and hosted on Mintlify, a developer documentation platform
On this page
* 1. Open MCPJam
* 2. Draw something
* 3. Connect your own server
* 4. Where to go next
* FAQ
Assistant
Responses are generated using AI and may contain mistakes.
Contact support
Links found on this page
- /llms.txt [direct]
- Skip to main content [direct]
- MCPJam Inspector home page [direct]
- Discord [direct]
- GitHub [direct]
- Website [direct]
- Installation [direct]
- Hosted App [direct]
- Slack [direct]
- Okta SSO & SCIM [direct]
- GitHub Checks [direct]
- Common MCP Errors [direct]
- Error code reference [direct]
- Changelog [direct]
- Inspector [direct]
- CLI [direct]
- SDK [direct]
- API [direct]
- OAuth Debugger [direct]
- app.mcpjam.com [direct]
- Skills [direct]
- CLI OAuth login [direct]
- Saving Results [direct]
- linkedin [direct]
- x [direct]
- Powered by This documentation is built and hosted on Mintlify, a developer documentation platform [direct]
|
|