@standardbeagle/mcp-tui 0.3.0 → 0.5.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.
- package/README.md +64 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,12 +34,13 @@ Stop struggling with curl commands, JSON formatting, and connection issues. MCP-
|
|
|
34
34
|
- Batch operations and parallel execution capabilities
|
|
35
35
|
- Exit codes and error handling perfect for scripts
|
|
36
36
|
|
|
37
|
-
###
|
|
38
|
-
**Problem Solved:** Connect to
|
|
39
|
-
- STDIO transport for local processes and
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
37
|
+
### Transport Support
|
|
38
|
+
**Problem Solved:** Connect to MCP servers with reliable, standards-compliant transport
|
|
39
|
+
- ✅ **STDIO transport** for local processes and command execution
|
|
40
|
+
- ✅ **SSE (Server-Sent Events)** transport for web services and cloud deployments
|
|
41
|
+
- ✅ **HTTP transport** for standard web APIs and RESTful services
|
|
42
|
+
- ✅ **Streamable HTTP** transport for advanced MCP protocol compliance
|
|
43
|
+
- Built on official MCP Go SDK for maximum compatibility and protocol compliance
|
|
43
44
|
|
|
44
45
|
### Robust Error Handling
|
|
45
46
|
**Problem Solved:** Understand exactly what's wrong when servers misbehave
|
|
@@ -48,6 +49,17 @@ Stop struggling with curl commands, JSON formatting, and connection issues. MCP-
|
|
|
48
49
|
- Test servers that simulate real-world failure scenarios
|
|
49
50
|
- Graceful degradation when servers become unresponsive
|
|
50
51
|
|
|
52
|
+
### Enhanced Navigation & File Discovery
|
|
53
|
+
**Problem Solved:** Stop re-typing server configurations and struggle to find existing configs
|
|
54
|
+
- **Tabbed interface** with visual navigation between saved/discovered/manual modes
|
|
55
|
+
- **Smart file discovery** automatically finds Claude Desktop, VS Code, and MCP configs
|
|
56
|
+
- **Combined command input** - type "brum --mcp" in one field, not separate command/args
|
|
57
|
+
- **Arrow key navigation** between tabs and intuitive UI flow
|
|
58
|
+
- Auto-connect to single server setups or configured default servers
|
|
59
|
+
- Compatible with Claude Desktop and VS Code MCP configurations
|
|
60
|
+
- Recent connections tracking with success status
|
|
61
|
+
- Environment variable substitution for secure credential management
|
|
62
|
+
|
|
51
63
|
## 🚀 Get Started in 30 Seconds
|
|
52
64
|
|
|
53
65
|
### Installation
|
|
@@ -73,27 +85,45 @@ make install
|
|
|
73
85
|
```
|
|
74
86
|
*Benefits: Latest features, customizable, contribute back*
|
|
75
87
|
|
|
76
|
-
### Instant Connection -
|
|
88
|
+
### Instant Connection - Enhanced Experience
|
|
89
|
+
|
|
90
|
+
> **✨ New in v0.2.0**: Revolutionary UI with saved connections, file discovery, tabbed navigation, and combined command input. Built on the official MCP Go SDK with comprehensive security validation.
|
|
77
91
|
|
|
78
92
|
**🎯 Just Getting Started? Try This:**
|
|
79
93
|
```bash
|
|
80
|
-
#
|
|
94
|
+
# Open the enhanced TUI with file discovery and saved connections
|
|
95
|
+
mcp-tui
|
|
96
|
+
|
|
97
|
+
# Quick connect to MCP server via STDIO (single command line)
|
|
81
98
|
mcp-tui "npx -y @modelcontextprotocol/server-everything stdio"
|
|
99
|
+
|
|
100
|
+
# Or connect via SSE (Server-Sent Events) for web servers
|
|
101
|
+
mcp-tui --url http://localhost:8000/sse
|
|
102
|
+
```
|
|
103
|
+
*What's new: Visual tabs, file discovery finds existing configs, combined command input, arrow key navigation*
|
|
104
|
+
|
|
105
|
+
**💡 Smart Auto-Connect:**
|
|
106
|
+
If you have a saved configuration file with a single server or default server, MCP-TUI will auto-connect immediately:
|
|
107
|
+
```bash
|
|
108
|
+
# Create ~/.config/mcp-tui/connections.json or copy examples/single-server-config.json
|
|
109
|
+
mcp-tui # Connects automatically!
|
|
82
110
|
```
|
|
83
|
-
*Why this works: Skips all setup, connects instantly, shows you everything the server can do*
|
|
84
111
|
|
|
85
112
|
**🤖 Building Automation? Use CLI Mode:**
|
|
86
113
|
```bash
|
|
87
|
-
# List all available tools
|
|
114
|
+
# List all available tools via STDIO (combined command input)
|
|
88
115
|
mcp-tui "npx -y @modelcontextprotocol/server-everything stdio" tool list
|
|
89
116
|
|
|
117
|
+
# Or via SSE
|
|
118
|
+
mcp-tui --url http://localhost:8000/sse tool list
|
|
119
|
+
|
|
90
120
|
# Execute a specific tool with parameters
|
|
91
|
-
mcp-tui
|
|
121
|
+
mcp-tui --url http://localhost:8000/sse tool call echo message="Hello World"
|
|
92
122
|
|
|
93
123
|
# Get JSON output for your scripts
|
|
94
|
-
mcp-tui --json
|
|
124
|
+
mcp-tui --json --url http://localhost:8000/sse tool list
|
|
95
125
|
```
|
|
96
|
-
*Why this works:
|
|
126
|
+
*Why this works: Combined command input, perfect for CI/CD, scripts, and automated testing workflows*
|
|
97
127
|
|
|
98
128
|
**🌐 Have a Web Service? Connect via HTTP:**
|
|
99
129
|
```bash
|
|
@@ -322,14 +352,16 @@ mcp-tui prompt get <name> [args...] # Get a prompt with arguments
|
|
|
322
352
|
|
|
323
353
|
### Global Options
|
|
324
354
|
```bash
|
|
325
|
-
--
|
|
326
|
-
--
|
|
327
|
-
--url string # URL for SSE/HTTP servers
|
|
328
|
-
--type string # Transport type (stdio, sse, http)
|
|
355
|
+
--url string # URL for SSE servers (primary method)
|
|
356
|
+
--type string # Transport type (currently: sse)
|
|
329
357
|
--timeout duration # Connection timeout (default 30s)
|
|
330
358
|
--debug # Enable debug mode with detailed logging
|
|
331
359
|
--log-level string # Log level (debug, info, warn, error)
|
|
332
360
|
--json # Output results in JSON format
|
|
361
|
+
|
|
362
|
+
# Legacy options (STDIO support coming back soon):
|
|
363
|
+
--cmd string # Command to run MCP server (not yet implemented)
|
|
364
|
+
--args strings # Arguments for server command (not yet implemented)
|
|
333
365
|
```
|
|
334
366
|
|
|
335
367
|
## 🔍 Error Handling & Debugging
|
|
@@ -431,6 +463,21 @@ Error: PROTOCOL_VIOLATION: missing required field 'protocolVersion'
|
|
|
431
463
|
Error: SERVER_NOT_RESPONDING: no response to initialize request
|
|
432
464
|
```
|
|
433
465
|
|
|
466
|
+
**Debugging JSON Unmarshaling Errors:**
|
|
467
|
+
|
|
468
|
+
When servers send malformed responses, use `--debug` flag for detailed diagnostics:
|
|
469
|
+
|
|
470
|
+
```bash
|
|
471
|
+
# Example: Server sends array instead of object for properties field
|
|
472
|
+
mcp-tui --debug --url http://localhost:8080/mcp tool list
|
|
473
|
+
|
|
474
|
+
# Enhanced error output shows:
|
|
475
|
+
# - Original error message
|
|
476
|
+
# - Raw HTTP response body
|
|
477
|
+
# - Specific field causing the issue
|
|
478
|
+
# - Expected vs received types
|
|
479
|
+
```
|
|
480
|
+
|
|
434
481
|
## 🎯 Type System & Validation
|
|
435
482
|
|
|
436
483
|
### Automatic Type Conversion
|