{"id":33347340,"url":"https://github.com/mcp-use/inspector","last_synced_at":"2026-04-20T06:09:46.536Z","repository":{"id":325249925,"uuid":"1100393958","full_name":"mcp-use/inspector","owner":"mcp-use","description":"Modern MCP Inspector for remote mcp servers with support for Apps SDK","archived":false,"fork":false,"pushed_at":"2026-04-16T18:55:01.000Z","size":2861,"stargazers_count":13,"open_issues_count":0,"forks_count":4,"subscribers_count":0,"default_branch":"canary","last_synced_at":"2026-04-16T19:21:58.882Z","etag":null,"topics":["ai-tools","debugging","developer-tools","devtools","inspector","mcp","modelcontextprotocol","observability","protocol","typescript"],"latest_commit_sha":null,"homepage":"https://inspector.mcp-use.com","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mcp-use.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-20T08:15:36.000Z","updated_at":"2026-04-16T17:16:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mcp-use/inspector","commit_stats":null,"previous_names":["mcp-use/inspector"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mcp-use/inspector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcp-use%2Finspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcp-use%2Finspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcp-use%2Finspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcp-use%2Finspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mcp-use","download_url":"https://codeload.github.com/mcp-use/inspector/tar.gz/refs/heads/canary","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcp-use%2Finspector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32035281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-tools","debugging","developer-tools","devtools","inspector","mcp","modelcontextprotocol","observability","protocol","typescript"],"created_at":"2025-11-22T08:01:05.209Z","updated_at":"2026-04-20T06:09:46.530Z","avatar_url":"https://github.com/mcp-use.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e ⚠️ This is a read-only mirror of `libraries/typescript/packages/inspector` in the [mcp-use/mcp-use](https://github.com/mcp-use/mcp-use) monorepo.\n\u003e\n\u003e 🚀 Please submit issues and pull requests to the monorepo instead.\n\u003e\n\u003e 🛠 This branch mirrors: `canary`\n\u003e\n\u003e 🌐 Source folder: `libraries/typescript/packages/inspector`\n\n\u003cdiv align=\"center\" style=\"margin: 0 auto; max-width: 80%;\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/mcp-use/mcp-use/main/static/logo_white.svg\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/mcp-use/mcp-use/main/static/logo_black.svg\"\u003e\n    \u003cimg alt=\"mcp use logo\" src=\"https://raw.githubusercontent.com/mcp-use/mcp-use/main/static/logo_white.svg\" width=\"80%\" style=\"margin: 20px auto;\"\u003e\n  \u003c/picture\u003e\n\u003c/div\u003e\n\n\u003ch1 align=\"center\"\u003eMCP Inspector\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@mcp-use/inspector\" alt=\"NPM Downloads\"\u003e\n        \u003cimg src=\"https://img.shields.io/npm/dw/@mcp-use/inspector.svg\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@mcp-use/inspector\" alt=\"NPM Version\"\u003e\n        \u003cimg src=\"https://img.shields.io/npm/v/@mcp-use/inspector.svg\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/mcp-use/mcp-use/blob/main/LICENSE\" alt=\"License\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/mcp-use/mcp-use\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/mcp-use/mcp-use/stargazers\" alt=\"GitHub stars\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/stars/mcp-use/mcp-use?style=social\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://discord.gg/XkNkSkMz3V\" alt=\"Discord\"\u003e\n        \u003cimg src=\"https://dcbadge.limes.pink/api/server/XkNkSkMz3V?style=flat\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n🔍 **MCP Inspector by mcp-use** is an open-source, interactive developer tool for testing and debugging MCP servers with support for MCP-UI and OpenAI Apps SDK widgets. It provides a beautiful, intuitive interface for testing tools, exploring resources, managing prompts, and monitoring server connections - all from your browser.\n\n## 🚀 Try it:\n\n- **Online**: [inspector.mcp-use.com](https://inspector.mcp-use.com/inspector)\n- **Locally**: Run `npx @mcp-use/inspector`\n- **Repository**: [github.com/mcp-use/mcp-use](https://github.com/mcp-use/mcp-use/tree/main/libraries/typescript/packages/inspector)\n\n## 🎥 Demo\n\n[![mcp-use inspector demo video](https://github.com/user-attachments/assets/4ef1643b-6f28-473e-8e7b-40c0c454d69d)](https://www.youtube.com/watch?v=DvsNSABz1GM)\n\n### 📖 Documentation\n\nFor detailed usage instructions and guides, visit [mcp-use.com/docs/inspector](https://mcp-use.com/docs/inspector)\n\n---\n\n## 📦 Related Packages\n\n| Package                                                                                                             | Description             | Version                                                                                                         |\n| ------------------------------------------------------------------------------------------------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------- |\n| [mcp-use](https://github.com/mcp-use/mcp-use/tree/main/libraries/typescript/packages/mcp-use)                       | Core MCP framework      | [![npm](https://img.shields.io/npm/v/mcp-use.svg)](https://www.npmjs.com/package/mcp-use)                       |\n| [@mcp-use/cli](https://github.com/mcp-use/mcp-use/tree/main/libraries/typescript/packages/cli)                      | Build tool for MCP apps | [![npm](https://img.shields.io/npm/v/@mcp-use/cli.svg)](https://www.npmjs.com/package/@mcp-use/cli)             |\n| [create-mcp-use-app](https://github.com/mcp-use/mcp-use/tree/main/libraries/typescript/packages/create-mcp-use-app) | Create MCP apps         | [![npm](https://img.shields.io/npm/v/create-mcp-use-app.svg)](https://www.npmjs.com/package/create-mcp-use-app) |\n\n---\n\n## ✨ Key Features\n\n| Feature                    | Description                                                        |\n| -------------------------- | ------------------------------------------------------------------ |\n| **🚀 Auto-Mount**          | Automatically available at `/inspector` for all mcp-use servers    |\n| **🔌 Multi-Connection**    | Connect to and manage multiple MCP servers simultaneously          |\n| **🎯 Interactive Testing** | Test tools with live execution and real-time results               |\n| **📊 Real-time Status**    | Monitor connection states, errors, and server health               |\n| **🔐 OAuth Support**       | Built-in OAuth flow handling with popup authentication             |\n| **💾 Persistent Sessions** | Connections saved to localStorage and auto-reconnect               |\n| **🎨 Beautiful UI**        | Modern, responsive interface built with React and Tailwind         |\n| **🔍 Tool Explorer**       | Browse and execute all available tools with schema validation      |\n| **📁 Resource Browser**    | View and copy resource URIs with syntax highlighting               |\n| **💬 Prompt Manager**      | Test and manage prompts with argument templates                    |\n| **🌐 Universal Support**   | Works with HTTP/SSE and WebSocket connections                      |\n| **🎨 Widget Support**      | Full support for MCP-UI and OpenAI Apps SDK widgets                |\n| **🔑 BYOK Chat**           | Bring Your Own Key chat interface for testing conversational flows |\n| **💾 Saved Tool Calls**    | Save and replay tool executions for repeated testing               |\n| **⌨️ Quick Actions**       | Cmd + K keyboard shortcuts for rapid navigation                    |\n| **🐳 Docker Ready**        | Self-host with a single Docker container for production use        |\n\n---\n\n## 🚀 Quick Start\n\n### Access the Inspector\n\nThere are three ways to use the MCP Inspector:\n\n#### 1. Online Version (Recommended for Testing)\n\nVisit [inspector.mcp-use.com](https://inspector.mcp-use.com/inspector) - no installation required!\n\n#### 2. Run Locally\n\n```bash\nnpx @mcp-use/inspector\n```\n\nOpens the inspector in your browser at `http://localhost:8080`\n\n#### 3. Auto-mounted with mcp-use Servers\n\nWhen you create an MCP server with `mcp-use`, the inspector is automatically available at `/inspector`:\n\n```typescript\nimport { MCPServer } from \"mcp-use/server\";\n\nconst server = new MCPServer({\n  name: \"my-server\",\n  version: \"1.0.0\",\n});\n\n// Add your tools, resources, prompts...\n\nserver.listen(3000);\n// 🎉 Inspector automatically available at http://localhost:3000/inspector\n```\n\n---\n\n## 📖 Usage Guide\n\n### Dashboard\n\nThe main dashboard is your central hub for managing MCP server connections:\n\n- **Connected Servers Panel** (left): View all your connected servers\n- **Connect Panel** (right): Add new server connections with transport, URL, auth, and headers configuration\n- **Quick Actions**: Access settings and clear sessions from the top bar\n\n### Adding an MCP Server\n\nTo connect to an MCP server:\n\n1. **Open Connect Panel**: Click the Connect panel on the right side of the dashboard\n2. **Configure Transport**:\n   - Select \"Streamable HTTP\" for SSE connections\n   - Select \"WebSocket\" for WS connections\n   - Configure \"stdin/stdio\" for local process connections\n3. **Enter Server URL**: Input the MCP server endpoint (e.g., `https://mcp.linear.app/mcp`)\n4. **Configure Authentication** (if needed): Add OAuth credentials or API headers\n5. **Click Connect**: Establish the connection\n\nExample URLs:\n\n- Linear: `https://mcp.linear.app/mcp`\n- Local: `http://localhost:3000/mcp`\n\n### OAuth Authentication\n\nFor servers requiring OAuth (like Linear):\n\n1. After clicking **Connect**, you'll see the authorization page\n2. Click **\"Approve\"** to grant access\n3. The inspector handles the redirect automatically\n4. Server appears in Connected Servers list with a green indicator\n\n\u003e **Privacy Note**: All authentication tokens and credentials are stored securely in your browser's local storage. Nothing is sent to our servers - everything stays on your device.\n\n### Connected Servers\n\nOnce connected, each server shows:\n\n- Connection status indicator (green = connected)\n- Server name and URL\n- Available tools count\n- Action buttons: **Inspect**, **Disconnect**, **Remove**\n\nClick **\"Inspect\"** to open the detailed server view.\n\n---\n\n## 🔍 Server Detail View\n\nAfter clicking **\"Inspect\"** on a connected server, you'll see four main tabs:\n\n### Tools Tab\n\nThe Tools tab displays all available tools from the MCP server.\n\n**Features:**\n\n- Browse all available tools with their names and descriptions\n- Select a tool to view its detailed schema\n- Click **\"Execute\"** to test the tool\n- Enter JSON parameters in the input panel\n- View real-time results with syntax highlighting\n- Support for MCP-UI and OpenAI Apps SDK widgets\n\n**Example**: When connected to Linear MCP server, you'll see 23+ tools for managing issues, projects, and teams.\n\n### Resources Tab\n\nBrowse available resources from the MCP server:\n\n- View resource descriptions and metadata\n- Copy resource URIs for use in your applications\n- Check MIME types and resource properties\n- Preview resource content\n\n\u003e **Note**: Some servers (like Linear) may not expose resources, in which case you'll see \"No resources available\".\n\n### Prompts Tab\n\nTest and manage pre-configured prompts:\n\n- View all available prompts with descriptions\n- Select a prompt to see its schema\n- Fill in required arguments in the form\n- Click **\"Render\"** to execute the prompt\n- Copy the rendered output for use\n\n\u003e **Note**: Not all servers provide prompts. If none are available, you'll see \"No prompts available\".\n\n### Elicitation Tab\n\nThe Elicitation tab handles tool requests that require user input during execution.\n\n**Features:**\n\n- View pending elicitation requests in a dedicated queue\n- Fill and submit form-mode responses directly in the inspector\n- Accept, decline, or cancel requests\n- Jump back to tool results after responding\n\n**Supported field types:**\n\n- Text, number/integer, and boolean fields\n- Single-select enum dropdowns:\n  - `type: \"string\" + enum`\n  - `type: \"string\" + oneOf[{ const, title }]`\n  - `type: \"string\" + enum + enumNames` (legacy)\n- Multi-select enum groups:\n  - `type: \"array\" + items.enum`\n  - `type: \"array\" + items.anyOf[{ const, title }]`\n\nThis aligns with SEP-1330 enum schema variants used by MCP conformance scenarios.\n\n### Chat Tab\n\nThe Chat tab provides an interactive interface to test the MCP server with an LLM using **BYOK (Bring Your Own Key)**.\n\n\u003e **Privacy**: Your API key is stored locally in your browser and never sent to our servers. All requests are made directly from your device to your LLM provider.\n\n**Setup:**\n\n1. Click **\"Configure API Key\"** to open the configuration modal\n2. Select your **Provider** (OpenAI, Anthropic, etc.)\n3. Choose the **Model** (gpt-4o, claude-3-5-sonnet, etc.)\n4. Enter your **API Key** (stored locally in browser)\n5. Click **\"Save Configuration\"**\n\n**Using Chat:**\n\n- Type natural language queries to test the MCP server\n- View tool calls in real-time with visual indicators\n- See detailed JSON output for arguments and results\n- Watch the assistant's response based on tool results\n- Track exactly how the MCP server processes requests\n\n---\n\n## ⌨️ Keyboard Shortcuts\n\n| Shortcut       | Action                      |\n| -------------- | --------------------------- |\n| `Cmd/Ctrl + K` | Quick search and navigation |\n| `Esc`          | Close modals and overlays   |\n\n**Quick Search (Cmd/Ctrl + K)** allows you to:\n\n- Quickly connect to a new server\n- Access documentation and tutorials\n- Jump to recently used servers\n- Search and execute tools directly\n- Navigate to different tabs\n\n---\n\n## 💾 Persistency\n\nThe inspector automatically saves your configurations:\n\n- **Server connections** persist across page reloads\n- **Credentials** are stored securely in your browser's localStorage\n- **Session preferences** are maintained automatically\n- Clear all sessions anytime with the **\"Clear All\"** button\n\nYour data never leaves your browser - everything is stored locally for privacy and security.\n\n---\n\n## 🐳 Self-Hosting\n\nDeploy the MCP Inspector to your own infrastructure with a single Docker container. Perfect for enterprise environments, air-gapped networks, or when you need full control over your debugging environment.\n\n### Docker Image\n\nThe official Docker image is available on [Docker Hub](https://hub.docker.com/r/mcpuse/inspector).\n\n**Quick Start:**\n\n```bash\ndocker run -d -p 8080:8080 --name mcp-inspector mcpuse/inspector:latest\n```\n\nThen visit `http://localhost:8080` to access your self-hosted inspector.\n\n### Docker Deployment Options\n\n**Using Docker Run:**\n\n```bash\ndocker run -d \\\n  --name mcp-inspector \\\n  -p 8080:8080 \\\n  -e NODE_ENV=production \\\n  mcpuse/inspector:latest\n```\n\n**Using Docker Compose:**\n\n```yaml\nversion: \"3.8\"\nservices:\n  mcp-inspector:\n    image: mcpuse/inspector:latest\n    ports:\n      - \"8080:8080\"\n    environment:\n      - NODE_ENV=production\n      - PORT=8080\n    restart: unless-stopped\n    healthcheck:\n      test: [\"CMD\", \"curl\", \"-f\", \"http://localhost:8080\"]\n      interval: 30s\n      timeout: 10s\n      retries: 3\n```\n\n### Environment Variables\n\nAll configuration is optional. The inspector works out of the box with sensible defaults.\n\n| Variable   | Default    | Description                  |\n| ---------- | ---------- | ---------------------------- |\n| `NODE_ENV` | production | Node.js environment          |\n| `PORT`     | 8080       | Port to run the inspector on |\n| `HOST`     | 0.0.0.0    | Host to bind to              |\n\n---\n\n## 📊 Telemetry \u0026 Privacy\n\nThe MCP Inspector collects anonymized usage data to help us improve the tool.\n\n### What Data is Collected?\n\nWe collect:\n\n- **Usage events**: When you connect to servers, execute tools, read resources, or call prompts\n- **Anonymous user ID**: A randomly generated UUID stored in your browser's localStorage\n- **Technical information**: Package version, browser type, and connection types\n- **Performance data**: Tool execution duration and success/failure rates\n\nWe **DO NOT** collect:\n\n- Personal information (names, emails, etc.)\n- Actual tool arguments or results\n- Server credentials or API keys\n- Resource content or data\n\n### How to Opt Out\n\nYou can disable telemetry in several ways:\n\n**Option 1: Environment Variable**\n\n```bash\n# Set before starting the inspector\nexport MCP_USE_ANONYMIZED_TELEMETRY=false\n```\n\n**Option 2: localStorage (Browser)**\n\n```javascript\n// In browser console\nlocalStorage.setItem(\"mcp_inspector_telemetry_disabled\", \"true\");\n```\n\n**Option 3: Package-level**\n\n```json\n// Add to your package.json\n{\n  \"scarfSettings\": {\n    \"enabled\": false\n  }\n}\n```\n\n### Telemetry Providers\n\nWe use:\n\n- **PostHog**: For product analytics and feature usage tracking\n- **Scarf**: For package download analytics and company insights\n\n## Both providers respect your privacy and follow GDPR compliance.\n\n## 🤝 Contributing\n\nWe welcome contributions!\n\nSee our [contributing guide](https://github.com/mcp-use/mcp-use/blob/main/CONTRIBUTING.md) for details.\n\n---\n\n## 📚 Learn More\n\n- [Inspector Documentation](https://mcp-use.com/docs/inspector) - Complete usage guide and tutorials\n- [Self-Hosting Guide](https://mcp-use.com/docs/inspector/self-hosting) - Deploy your own instance\n- [mcp-use Documentation](https://mcp-use.com/docs) - Full framework documentation\n- [Model Context Protocol](https://modelcontextprotocol.io) - Official MCP specification\n- [GitHub Repository](https://github.com/mcp-use/mcp-use) - Source code and examples\n\n---\n\n## 📜 License\n\nMIT © [mcp-use](https://github.com/mcp-use)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcp-use%2Finspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcp-use%2Finspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcp-use%2Finspector/lists"}