mcp-inspect 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +107 -0
  3. package/dist/src/App.d.ts +7 -0
  4. package/dist/src/App.d.ts.map +1 -0
  5. package/dist/src/App.js +591 -0
  6. package/dist/src/App.js.map +1 -0
  7. package/dist/src/components/DetailsModal.d.ts +11 -0
  8. package/dist/src/components/DetailsModal.d.ts.map +1 -0
  9. package/dist/src/components/DetailsModal.js +50 -0
  10. package/dist/src/components/DetailsModal.js.map +1 -0
  11. package/dist/src/components/HistoryTab.d.ts +13 -0
  12. package/dist/src/components/HistoryTab.d.ts.map +1 -0
  13. package/dist/src/components/HistoryTab.js +122 -0
  14. package/dist/src/components/HistoryTab.js.map +1 -0
  15. package/dist/src/components/InfoTab.d.ts +13 -0
  16. package/dist/src/components/InfoTab.d.ts.map +1 -0
  17. package/dist/src/components/InfoTab.js +28 -0
  18. package/dist/src/components/InfoTab.js.map +1 -0
  19. package/dist/src/components/NotificationsTab.d.ts +13 -0
  20. package/dist/src/components/NotificationsTab.d.ts.map +1 -0
  21. package/dist/src/components/NotificationsTab.js +37 -0
  22. package/dist/src/components/NotificationsTab.js.map +1 -0
  23. package/dist/src/components/PromptsTab.d.ts +13 -0
  24. package/dist/src/components/PromptsTab.d.ts.map +1 -0
  25. package/dist/src/components/PromptsTab.js +60 -0
  26. package/dist/src/components/PromptsTab.js.map +1 -0
  27. package/dist/src/components/ResourcesTab.d.ts +13 -0
  28. package/dist/src/components/ResourcesTab.d.ts.map +1 -0
  29. package/dist/src/components/ResourcesTab.js +60 -0
  30. package/dist/src/components/ResourcesTab.js.map +1 -0
  31. package/dist/src/components/Tabs.d.ts +24 -0
  32. package/dist/src/components/Tabs.d.ts.map +1 -0
  33. package/dist/src/components/Tabs.js +22 -0
  34. package/dist/src/components/Tabs.js.map +1 -0
  35. package/dist/src/components/ToolTestModal.d.ts +11 -0
  36. package/dist/src/components/ToolTestModal.d.ts.map +1 -0
  37. package/dist/src/components/ToolTestModal.js +112 -0
  38. package/dist/src/components/ToolTestModal.js.map +1 -0
  39. package/dist/src/components/ToolsTab.d.ts +14 -0
  40. package/dist/src/components/ToolsTab.d.ts.map +1 -0
  41. package/dist/src/components/ToolsTab.js +76 -0
  42. package/dist/src/components/ToolsTab.js.map +1 -0
  43. package/dist/src/hooks/useMCPClient.d.ts +41 -0
  44. package/dist/src/hooks/useMCPClient.d.ts.map +1 -0
  45. package/dist/src/hooks/useMCPClient.js +179 -0
  46. package/dist/src/hooks/useMCPClient.js.map +1 -0
  47. package/dist/src/hooks/useMessageTracking.d.ts +9 -0
  48. package/dist/src/hooks/useMessageTracking.d.ts.map +1 -0
  49. package/dist/src/hooks/useMessageTracking.js +124 -0
  50. package/dist/src/hooks/useMessageTracking.js.map +1 -0
  51. package/dist/src/types/focus.d.ts +2 -0
  52. package/dist/src/types/focus.d.ts.map +1 -0
  53. package/dist/src/types/focus.js +2 -0
  54. package/dist/src/types/focus.js.map +1 -0
  55. package/dist/src/types/messages.d.ts +14 -0
  56. package/dist/src/types/messages.d.ts.map +1 -0
  57. package/dist/src/types/messages.js +2 -0
  58. package/dist/src/types/messages.js.map +1 -0
  59. package/dist/src/types.d.ts +48 -0
  60. package/dist/src/types.d.ts.map +1 -0
  61. package/dist/src/types.js +2 -0
  62. package/dist/src/types.js.map +1 -0
  63. package/dist/src/utils/schemaToForm.d.ts +9 -0
  64. package/dist/src/utils/schemaToForm.d.ts.map +1 -0
  65. package/dist/src/utils/schemaToForm.js +107 -0
  66. package/dist/src/utils/schemaToForm.js.map +1 -0
  67. package/dist/tui.d.ts +3 -0
  68. package/dist/tui.d.ts.map +1 -0
  69. package/dist/tui.js +43 -0
  70. package/dist/tui.js.map +1 -0
  71. package/package.json +58 -0
  72. package/screenshots/mcp-inspector.png +0 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 TeamSpark, LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,107 @@
1
+ # mcp-inspect
2
+
3
+ A terminal UI (TUI) inspector for Model Context Protocol (MCP) servers. Inspect server capabilities, resources, prompts, tools, message history, and MCP server logs, and test tools, all in an interactive terminal interface. Similar to [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) but works from any terminal session, including inside of sandboxes or containers.
4
+
5
+ ![mcp-inspect TUI](screenshots/mcp-inspector.png)
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install -g mcp-inspect
11
+ ```
12
+
13
+ Or use via npx:
14
+
15
+ ```bash
16
+ npx mcp-inspect <config-file.json>
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ```bash
22
+ mcp-inspect <config-file.json>
23
+ ```
24
+
25
+ Where `config-file.json` is your MCP configuration file (typically `mcp.json`).
26
+
27
+ ### Configuration File Format
28
+
29
+ The configuration file should follow the MCP configuration format:
30
+
31
+ ```json
32
+ {
33
+ "mcpServers": {
34
+ "server-name": {
35
+ "type": "stdio",
36
+ "command": "node",
37
+ "args": ["server.js"]
38
+ },
39
+ "another-server": {
40
+ "type": "sse",
41
+ "url": "http://localhost:6969/sse"
42
+ }
43
+ }
44
+ }
45
+ ```
46
+
47
+ Supported transport types:
48
+ - `stdio` - Standard input/output communication
49
+ - `sse` - Server-Sent Events
50
+ - `streamableHttp` - Streamable HTTP
51
+
52
+ ## Features
53
+
54
+ - **Server Management**: Connect to multiple MCP servers simultaneously
55
+ - **Resource Inspection**: Browse and view available resources
56
+ - **Prompt Templates**: View and inspect prompt templates
57
+ - **Tool Testing**: Test MCP tools with custom inputs and view results
58
+ - **Message History**: Track all requests, responses, and notifications
59
+ - **Logging**: View server stderr output and notifications
60
+ - **Interactive UI**: Navigate with keyboard shortcuts
61
+
62
+ ## Keyboard Shortcuts
63
+
64
+ ### Global
65
+ - `ESC` - Exit application
66
+ - `Ctrl+C` - Exit application
67
+ - `Tab` / `Shift+Tab` - Cycle focus between panes
68
+ - `↑` / `↓` - Navigate lists and scroll content
69
+ - `Enter` - Select item / Test tool
70
+ - `+` - Zoom to full-screen modal view (in details panes)
71
+
72
+ ### Tabs
73
+ - Quick switch to tabs:
74
+ - `I` - Info
75
+ - `R` - Resources
76
+ - `P` - Prompts
77
+ - `T` - Tools
78
+ - `M` - Messages
79
+ - `L` - Logging
80
+
81
+ ### Server Management
82
+ - `C` - Connect to selected server (when disconnected or in error state)
83
+ - `D` - Disconnect from selected server (when connected)
84
+
85
+ ### Tool Testing
86
+ - `Enter` - Test tool (from tool list or details view)
87
+
88
+ ## Development
89
+
90
+ ```bash
91
+ # Install dependencies
92
+ npm install
93
+
94
+ # Build
95
+ npm run build
96
+
97
+ # Run in development mode
98
+ npm run dev <config-file.json>
99
+ ```
100
+
101
+ ## License
102
+
103
+ MIT
104
+
105
+ ## Contributing
106
+
107
+ Contributions welcome! Please open an issue or submit a pull request.
@@ -0,0 +1,7 @@
1
+ interface AppProps {
2
+ configFile: string;
3
+ onExit?: (code?: number) => void;
4
+ }
5
+ declare function App({ configFile, onExit }: AppProps): import("react/jsx-runtime").JSX.Element;
6
+ export default App;
7
+ //# sourceMappingURL=App.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../src/App.tsx"],"names":[],"mappings":"AAqCA,UAAU,QAAQ;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CAClC;AAED,iBAAS,GAAG,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,QAAQ,2CAo/B5C;AAED,eAAe,GAAG,CAAC"}