-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathdoctor_cmd.go
More file actions
488 lines (430 loc) Β· 17 KB
/
Copy pathdoctor_cmd.go
File metadata and controls
488 lines (430 loc) Β· 17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"sort"
"time"
"github.com/spf13/cobra"
"go.uber.org/zap"
"github.com/smart-mcp-proxy/mcpproxy-go/internal/cliclient"
"github.com/smart-mcp-proxy/mcpproxy-go/internal/config"
"github.com/smart-mcp-proxy/mcpproxy-go/internal/socket"
)
var (
doctorCmd = &cobra.Command{
Use: "doctor",
Short: "Run health checks to identify issues",
Long: `Run comprehensive health checks on MCPProxy to identify:
- Upstream server connection errors
- OAuth authentication requirements
- Missing secrets
- Runtime warnings
- Docker isolation status
This is the first command to run when debugging server issues.
Examples:
mcpproxy doctor
mcpproxy doctor --output=json`,
RunE: runDoctor,
}
// Command flags
doctorOutput string
doctorLogLevel string
doctorConfigPath string
)
// GetDoctorCommand returns the doctor command for adding to the root command.
// The doctor command runs comprehensive health checks on MCPProxy to identify
// upstream server connection errors, OAuth authentication requirements, missing
// secrets, and runtime warnings. This is the first command to run when debugging
// server issues.
func GetDoctorCommand() *cobra.Command {
return doctorCmd
}
func init() {
doctorCmd.Flags().StringVarP(&doctorOutput, "output", "o", "pretty", "Output format (pretty, json)")
doctorCmd.Flags().StringVarP(&doctorLogLevel, "log-level", "l", "warn", "Log level")
doctorCmd.Flags().StringVarP(&doctorConfigPath, "config", "c", "", "Path to config file")
}
func runDoctor(_ *cobra.Command, _ []string) error {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
// Load configuration
globalConfig, err := loadDoctorConfig()
if err != nil {
fmt.Fprintf(os.Stderr, "Error loading configuration: %v\n", err)
return err
}
// Create logger
logger, err := createDoctorLogger(doctorLogLevel)
if err != nil {
fmt.Fprintf(os.Stderr, "Error creating logger: %v\n", err)
return err
}
// Check if daemon is running
if !shouldUseDoctorDaemon(globalConfig.DataDir) {
return fmt.Errorf("doctor requires running daemon. Start with: mcpproxy serve")
}
logger.Info("Fetching diagnostics from daemon")
return runDoctorClientMode(ctx, globalConfig.DataDir, logger)
}
func shouldUseDoctorDaemon(dataDir string) bool {
socketPath := socket.DetectSocketPath(dataDir)
return socket.IsSocketAvailable(socketPath)
}
func runDoctorClientMode(ctx context.Context, dataDir string, logger *zap.Logger) error {
socketPath := socket.DetectSocketPath(dataDir)
client := cliclient.NewClient(socketPath, logger.Sugar())
// Call GET /api/v1/info with refresh=true to get fresh update info
info, err := client.GetInfoWithRefresh(ctx, true)
if err != nil {
logger.Debug("Failed to get info from daemon", zap.Error(err))
// Non-fatal: continue with diagnostics even if info fails
}
// Call GET /api/v1/diagnostics
diag, err := client.GetDiagnostics(ctx)
if err != nil {
return fmt.Errorf("failed to get diagnostics from daemon: %w", err)
}
return outputDiagnostics(diag, info)
}
func outputDiagnostics(diag map[string]interface{}, info map[string]interface{}) error {
switch doctorOutput {
case "json":
// Combine diagnostics with info for JSON output
combined := map[string]interface{}{
"diagnostics": diag,
}
if info != nil {
combined["info"] = info
}
output, err := json.MarshalIndent(combined, "", " ")
if err != nil {
return fmt.Errorf("failed to format output: %w", err)
}
fmt.Println(string(output))
case "pretty", "": // Handle both "pretty" and empty string (default value)
// Pretty format - parse and display diagnostics
totalIssues := getIntField(diag, "total_issues")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
fmt.Println("π MCPProxy Health Check")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
// Display version information
if info != nil {
version := getStringField(info, "version")
if version != "" {
// Check for update info
if updateInfo, ok := info["update"].(map[string]interface{}); ok {
updateAvailable := getBoolField(updateInfo, "available")
latestVersion := getStringField(updateInfo, "latest_version")
releaseURL := getStringField(updateInfo, "release_url")
if updateAvailable && latestVersion != "" {
fmt.Printf("Version: %s (update available: %s)\n", version, latestVersion)
if releaseURL != "" {
fmt.Printf("Download: %s\n", releaseURL)
}
} else {
fmt.Printf("Version: %s (latest)\n", version)
}
} else {
fmt.Printf("Version: %s\n", version)
}
}
}
fmt.Println()
if totalIssues == 0 {
fmt.Println("β
All systems operational! No issues detected.")
fmt.Println()
// Show deprecated config warnings even when no issues
displayDeprecatedConfigs(diag)
// Display security features status even when no issues
fmt.Println("π Security Features")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
displaySecurityFeaturesStatus()
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
return nil
}
// Show issue summary
issueWord := "issue"
if totalIssues > 1 {
issueWord = "issues"
}
fmt.Printf("β οΈ Found %d %s that need attention\n", totalIssues, issueWord)
fmt.Println()
// 1. Upstream Connection Errors
if upstreamErrors := getArrayField(diag, "upstream_errors"); len(upstreamErrors) > 0 {
// Sort by server name for consistent output
sortArrayByServerName(upstreamErrors)
fmt.Println("β Upstream Server Connection Errors")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
for _, errItem := range upstreamErrors {
if errMap, ok := errItem.(map[string]interface{}); ok {
server := getStringField(errMap, "server_name")
message := getStringField(errMap, "error_message")
fmt.Printf("\nServer: %s\n", server)
fmt.Printf(" Error: %s\n", message)
}
}
fmt.Println()
fmt.Println("π‘ Remediation:")
fmt.Println(" β’ Check server configuration in mcp_config.json")
fmt.Println(" β’ View detailed logs: mcpproxy upstream logs <server-name>")
fmt.Println(" β’ Restart server: mcpproxy upstream restart <server-name>")
fmt.Println(" β’ Disable if not needed: mcpproxy upstream disable <server-name>")
fmt.Println()
}
// 2. OAuth Required
if oauthRequired := getArrayField(diag, "oauth_required"); len(oauthRequired) > 0 {
// Sort by server name for consistent output
sortArrayByServerName(oauthRequired)
fmt.Println("π OAuth Authentication Required")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
for _, item := range oauthRequired {
if oauthMap, ok := item.(map[string]interface{}); ok {
serverName := getStringField(oauthMap, "server_name")
message := getStringField(oauthMap, "message")
fmt.Printf("\nServer: %s\n", serverName)
if message != "" {
fmt.Printf(" %s\n", message)
} else {
fmt.Printf(" Run: mcpproxy auth login --server=%s\n", serverName)
}
}
}
fmt.Println()
}
// 3. OAuth Configuration Issues
if oauthIssues := getArrayField(diag, "oauth_issues"); len(oauthIssues) > 0 {
// Sort by server name for consistent output
sortArrayByServerName(oauthIssues)
fmt.Println("π OAuth Configuration Issues")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
for _, issueItem := range oauthIssues {
if issueMap, ok := issueItem.(map[string]interface{}); ok {
serverName := getStringField(issueMap, "server_name")
issue := getStringField(issueMap, "issue")
errorMsg := getStringField(issueMap, "error")
resolution := getStringField(issueMap, "resolution")
docURL := getStringField(issueMap, "documentation_url")
fmt.Printf("\n Server: %s\n", serverName)
fmt.Printf(" Issue: %s\n", issue)
fmt.Printf(" Error: %s\n", errorMsg)
fmt.Printf(" Impact: Server cannot authenticate until parameter is provided\n")
fmt.Println()
fmt.Printf(" Resolution:\n")
fmt.Printf(" %s\n", resolution)
if docURL != "" {
fmt.Printf(" Documentation: %s\n", docURL)
}
}
}
fmt.Println()
}
// 4. Missing Secrets
if missingSecrets := getArrayField(diag, "missing_secrets"); len(missingSecrets) > 0 {
fmt.Println("π Missing Secrets")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
for _, secretItem := range missingSecrets {
if secretMap, ok := secretItem.(map[string]interface{}); ok {
// Use correct field names from contracts.MissingSecretInfo
secretName := getStringField(secretMap, "secret_name")
usedBy := getArrayField(secretMap, "used_by")
fmt.Printf("\n β’ %s\n", secretName)
if len(usedBy) > 0 {
fmt.Printf(" Used by: ")
for i, server := range usedBy {
if serverStr, ok := server.(string); ok {
if i > 0 {
fmt.Printf(", ")
}
fmt.Printf("%s", serverStr)
}
}
fmt.Println()
}
}
}
fmt.Println()
fmt.Println("π‘ Remediation:")
fmt.Println(" β’ Set environment variables with required secrets")
fmt.Println(" β’ Update secret references in mcp_config.json")
fmt.Println(" β’ Use mcpproxy secrets command to manage secrets")
fmt.Println()
}
// 4. Runtime Warnings
if runtimeWarnings := getArrayField(diag, "runtime_warnings"); len(runtimeWarnings) > 0 {
fmt.Println("β οΈ Runtime Warnings")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
for _, warningItem := range runtimeWarnings {
if warningMap, ok := warningItem.(map[string]interface{}); ok {
message := getStringField(warningMap, "message")
severity := getStringField(warningMap, "severity")
title := getStringField(warningMap, "title")
// Display title if present, otherwise just the message
if title != "" {
fmt.Printf("\n β’ %s\n", title)
if message != "" {
fmt.Printf(" %s\n", message)
}
} else if message != "" {
fmt.Printf(" β’ %s\n", message)
}
if severity != "" && severity != "warning" {
fmt.Printf(" Severity: %s\n", severity)
}
}
}
fmt.Println()
fmt.Println("π‘ Remediation:")
fmt.Println(" β’ Review main log: tail -f ~/.mcpproxy/logs/main.log")
fmt.Println(" β’ Check server status: mcpproxy upstream list")
fmt.Println()
}
// Deprecated Configuration warnings
displayDeprecatedConfigs(diag)
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
fmt.Println()
fmt.Println("For more details, run: mcpproxy doctor --output=json")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
// Display security features status
fmt.Println()
fmt.Println("π Security Features")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
displaySecurityFeaturesStatus()
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
}
return nil
}
func loadDoctorConfig() (*config.Config, error) {
if doctorConfigPath != "" {
return config.LoadFromFile(doctorConfigPath)
}
return config.Load()
}
func createDoctorLogger(level string) (*zap.Logger, error) {
var zapLevel zap.AtomicLevel
switch level {
case "trace", "debug":
zapLevel = zap.NewAtomicLevelAt(zap.DebugLevel)
case "info":
zapLevel = zap.NewAtomicLevelAt(zap.InfoLevel)
case "warn":
zapLevel = zap.NewAtomicLevelAt(zap.WarnLevel)
case "error":
zapLevel = zap.NewAtomicLevelAt(zap.ErrorLevel)
default:
zapLevel = zap.NewAtomicLevelAt(zap.WarnLevel)
}
cfg := zap.Config{
Level: zapLevel,
Development: false,
Encoding: "console",
EncoderConfig: zap.NewDevelopmentEncoderConfig(),
OutputPaths: []string{"stderr"},
ErrorOutputPaths: []string{"stderr"},
}
return cfg.Build()
}
// sortArrayByServerName sorts an array of maps by the "server_name" field alphabetically.
func sortArrayByServerName(arr []interface{}) {
sort.Slice(arr, func(i, j int) bool {
iMap, iOk := arr[i].(map[string]interface{})
jMap, jOk := arr[j].(map[string]interface{})
if !iOk || !jOk {
return false
}
iName := getStringField(iMap, "server_name")
jName := getStringField(jMap, "server_name")
return iName < jName
})
}
// displayDeprecatedConfigs shows deprecated configuration warnings in the doctor output.
func displayDeprecatedConfigs(diag map[string]interface{}) {
deprecatedConfigs := getArrayField(diag, "deprecated_configs")
if len(deprecatedConfigs) == 0 {
return
}
fmt.Println("β οΈ Deprecated Configuration")
fmt.Println("βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ")
for _, item := range deprecatedConfigs {
if cfgMap, ok := item.(map[string]interface{}); ok {
field := getStringField(cfgMap, "field")
message := getStringField(cfgMap, "message")
replacement := getStringField(cfgMap, "replacement")
fmt.Printf("\n β’ %s\n", field)
fmt.Printf(" %s\n", message)
if replacement != "" {
fmt.Printf(" Suggestion: %s\n", replacement)
}
}
}
fmt.Println()
}
// displaySecurityFeaturesStatus shows the status of security features in the doctor output.
func displaySecurityFeaturesStatus() {
// Load config to check security feature settings
cfg, err := loadDoctorConfig()
if err != nil {
fmt.Println(" Unable to load configuration")
return
}
// Routing Mode status (Spec 031)
routingMode := cfg.RoutingMode
if routingMode == "" {
routingMode = config.RoutingModeRetrieveTools
}
fmt.Printf(" Routing Mode: %s\n", routingMode)
switch routingMode {
case config.RoutingModeDirect:
fmt.Println(" All upstream tools exposed directly via /mcp endpoint")
case config.RoutingModeCodeExecution:
fmt.Println(" JS orchestration via code_execution tool")
default:
fmt.Println(" BM25 search via retrieve_tools + call_tool variants")
}
fmt.Printf(" Endpoints: /mcp/all (direct), /mcp/code (code_execution), /mcp/call (retrieve_tools)\n")
fmt.Println()
// Sensitive Data Detection status
sddConfig := cfg.SensitiveDataDetection
if sddConfig == nil || sddConfig.IsEnabled() {
fmt.Println(" β Sensitive Data Detection: enabled (default)")
// Show enabled categories
if sddConfig != nil && sddConfig.Categories != nil {
enabledCategories := []string{}
for category, enabled := range sddConfig.Categories {
if enabled {
enabledCategories = append(enabledCategories, category)
}
}
if len(enabledCategories) > 0 {
sort.Strings(enabledCategories)
fmt.Printf(" Categories: %s\n", formatCategoryList(enabledCategories))
}
} else {
// Default categories when not explicitly configured
fmt.Println(" Categories: all (cloud_credentials, api_token, private_key, ...)")
}
fmt.Println(" View detections: mcpproxy activity list --sensitive-data")
} else {
fmt.Println(" β Sensitive Data Detection: disabled")
fmt.Println(" Enable: set sensitive_data_detection.enabled = true in config")
}
}
// formatCategoryList formats a list of categories for display, truncating if too long.
func formatCategoryList(categories []string) string {
if len(categories) <= 4 {
return joinStrings(categories, ", ")
}
return joinStrings(categories[:4], ", ") + fmt.Sprintf(", ... (%d total)", len(categories))
}
// joinStrings joins strings with a separator (simple helper).
func joinStrings(items []string, sep string) string {
result := ""
for i, item := range items {
if i > 0 {
result += sep
}
result += item
}
return result
}