Commit graph inspector/README.md
Author SHA1 Message Date
Felix Weinberger
698d2458c0
docs: Update README to reflect auto-open now works with authentication
- Removed outdated statement about auto-open being disabled with authentication
- Clarified that browser automatically opens with token pre-filled in URL
- Updated MCP_AUTO_OPEN_ENABLED description to note it works with authentication

The README now accurately reflects the improved developer experience where
authentication no longer prevents the browser from auto-opening.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-18 10:23:03 +01:00
Felix Weinberger
9dbd17343c
feat: disable auto-open when authentication is enabled
- Auto-open browser only works when DANGEROUSLY_OMIT_AUTH=true
- When auth is enabled (default), users must use the secure URL with token
- Server displays clear message that auto-open is disabled with auth
- Updates documentation to reflect this behavior

This improves UX by preventing the browser from opening without auth token,
forcing users to use the secure pre-filled URL instead.
2025-06-10 18:16:38 +01:00
Felix Weinberger
15ecb59a96
feat: add origin validation to prevent DNS rebinding attacks
- Add origin validation middleware to check Origin header
- Default allowed origins respect CLIENT_PORT environment variable
- Support ALLOWED_ORIGINS environment variable for additional origins
- Apply validation to all protected endpoints before auth check
- Return 403 Forbidden with clear message for invalid origins
- Add DNS Rebinding Protection section to README

This completes the security hardening by preventing malicious websites
from making requests to the local proxy server.
2025-06-10 18:16:35 +01:00
Felix Weinberger
111e282386
feat: add session token authentication to proxy server
- Generate random session token on server startup using crypto.randomBytes
- Add authentication middleware requiring Bearer token for all sensitive endpoints
- Apply auth to /mcp, /stdio, /sse, and /message endpoints
- Display session token in console on startup
- Add DANGEROUSLY_OMIT_AUTH environment variable to disable auth for development
- Update README with authentication documentation

This prevents unauthorized access to the proxy server's ability to execute
local processes and connect to MCP servers.
2025-06-10 18:16:28 +01:00
Felix Weinberger
e8e990987c
fix: bind to localhost by default to prevent DNS rebinding attacks
- Change default binding from 0.0.0.0 (all interfaces) to 127.0.0.1 (localhost only)
- Add HOST environment variable to override binding address when needed
- Update console output to show actual binding address
- Document security change in README with warnings about binding to all interfaces

This prevents remote attackers from accessing the MCP Inspector proxy server,
which has the ability to execute local processes. The proxy should only be
accessible from the local machine unless explicitly configured otherwise.
2025-06-10 18:16:24 +01:00
Cliff Hall
291c59eaf9
Merge branch 'main' into clarify-proxy-role-in-readme 2025-05-30 18:37:40 -04:00
olaservo
11757ef615 Add simple architecture overview 2025-05-30 07:46:28 -07:00
David Sanftenberg
66bb9c896b
Add quick start example 2025-05-28 12:22:22 +01:00
sumeetpardeshi
8ca5a34d12 fix readme after merging main 2025-05-12 20:30:54 -07:00
sumeetpardeshi
283371c313 Merge branch 'main' of https://github.com/modelcontextprotocol/inspector 2025-05-12 20:30:02 -07:00
Cliff Hall
8597100d54
Merge branch 'main' into auto_open 2025-05-12 12:45:26 -04:00
KAWAKAMI Moeki
eb3737d110 Fix format 2025-05-09 10:57:24 +09:00
Kent C. Dodds
2915cccd85 feat(client): make all config initialize-able via search params 2025-05-07 13:26:17 -06:00
Kent C. Dodds
3c5c38462b feat(client): initialize via search params 2025-05-07 13:26:17 -06:00
KAWAKAMI Moeki
db3f7a3542
Update README.md
Co-authored-by: Cliff Hall <cliff@futurescale.com>
2025-05-07 23:20:39 +09:00
sumeetpardeshi
bf402e5eb4 changing the readme for clarity based on PR review comments 2025-05-06 16:08:47 -07:00
sumeetpardeshi
be7fa9baf9 changes:
- change button names
- adding unit test cases
- updated landing page image
- updating README file
as discussed here: https://github.com/modelcontextprotocol/inspector/pull/334#issuecomment-2852394054
2025-05-05 17:32:06 -07:00
KAWAKAMI Moeki
d82e06fe65 Fix format of README.md 2025-04-18 09:29:42 +09:00
Cliff Hall
2fb2f0fbaf
Merge branch 'main' into auto_open 2025-04-17 11:26:35 -04:00
KAWAKAMI Moeki
014acecf77 Avoid double negative 2025-04-17 18:13:58 +09:00
KAWAKAMI Moeki
d2dc959307 Merge branch 'main' into auto_open 2025-04-17 18:13:53 +09:00
Hoa Lam
eba153847e
Merge branch 'main' into update-readme 2025-04-17 08:36:43 +07:00
ZK
d9100c8ed4
Merge branch 'main' into fix_readme_missing_character 2025-04-16 15:10:07 +08:00
Hoa Lam
61614052e5
Merge branch 'main' into update-readme 2025-04-16 08:54:50 +07:00
Hoa Lam
fa7eba23b7 Update README requirement node js version 2025-04-16 08:48:04 +07:00
Nicolas Barraud
fe02efd017
Merge branch 'main' into cli-and-config-file-support 2025-04-14 22:28:49 -04:00
ZK
24418bc2cd
Merge branch 'main' into fix_readme_missing_character 2025-04-15 09:57:52 +08:00
KAWAKAMI Moeki
a1fa0df0e6 Merge branch 'main' into auto_open 2025-04-13 21:22:12 +09:00
Ido Salomon
cd1bcfb15f
Update README.md
Co-authored-by: Ola Hungerford <olahungerford@gmail.com>
2025-04-12 22:52:47 +03:00
ZK
e4bfc058b2
fix README.md missing character 2025-04-13 00:06:04 +08:00
Nicolas Barraud
bbff5c5883
Merge branch 'main' into cli-and-config-file-support 2025-04-12 11:02:53 -04:00
Nicolas Barraud
8423776873 Fixed conflicts 2025-04-12 10:33:22 -04:00
Ido Salomon
aeac3ac914
Merge branch 'main' into set-header 2025-04-10 20:38:12 +03:00
Pulkit Sharma
779ca20568
Merge branch 'main' into progress_flow_support 2025-04-09 00:42:59 +05:30
cliffhall
6bcf1531c3 Bump version to 0.8.2
* In README
  - Point to inspector screenshot's rawcontent address so it doesn't appear as a broken image in the NPM package view.
2025-04-07 12:32:06 -04:00
KAWAKAMI Moeki
a524f17d80 Implement auto-open feature for browser launch on server start 2025-04-07 16:14:22 +09:00
Ido Salomon
91633de80f set header name 2025-04-05 12:46:25 +03:00
Pulkit Sharma
6be05c5278 update docs 2025-04-05 13:06:25 +05:30
Pulkit Sharma
0dcd10c1dd Update readme 2025-04-01 19:48:48 +05:30
Abdelkader Boudih
80f5ab1136
fix: typo 2025-03-31 18:28:40 +00:00
Abdelkader Boudih
da9dd09765
refactor: Update default ports for MCPI client and MPCP server
Changes the default ports used by the MCP Inspector client UI and the MCP Proxy server to avoid conflicts with common development ports and provide a memorable mnemonic based on T9 mapping.
2025-03-31 00:31:28 +00:00
Nicolas Barraud
65c589c193 Fixes to the formatting 2025-03-30 17:05:07 -04:00
Nicolas Barraud
5b22143c85 CLI and config file support 2025-03-30 15:57:29 -04:00
Pulkit Sharma
9e1186f5ac Document configuration in Readme and add TSDoc for the same. 2025-03-29 09:40:13 +05:30
Ola Hungerford
ec73831487 Fix formatting 2025-03-23 08:30:06 -07:00
Ola Hungerford
9b0da1f892 Add note on security considerations for proxy server 2025-03-23 08:19:52 -07:00
Nicolas Barraud
dae389034a Change --tool-args to --tool-arg for consistency 2025-03-11 12:40:39 -04:00
Nicolas Barraud
4c4c8a0884 Add CLI and config file support 2025-03-10 20:19:23 -04:00
Avi Mizrahi
dbd616905c Support bearer token 2025-03-10 17:50:12 +02:00
Ola Hungerford
266e8bec98 Fix formatting 2025-02-19 08:27:51 -07:00