-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathserver.go
More file actions
414 lines (342 loc) · 11.8 KB
/
server.go
File metadata and controls
414 lines (342 loc) · 11.8 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
package flashduty
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"log/slog"
"net/http"
"os"
"os/signal"
"strings"
"syscall"
"time"
"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
sdk "github.com/flashcatcloud/flashduty-sdk"
pkgerrors "github.com/flashcatcloud/flashduty-mcp-server/pkg/errors"
"github.com/flashcatcloud/flashduty-mcp-server/pkg/flashduty"
mcplog "github.com/flashcatcloud/flashduty-mcp-server/pkg/log"
"github.com/flashcatcloud/flashduty-mcp-server/pkg/trace"
"github.com/flashcatcloud/flashduty-mcp-server/pkg/translations"
)
// slogAdapter adapts slog.Logger to mcp-go's util.Logger interface
type slogAdapter struct {
logger *slog.Logger
}
func (a *slogAdapter) Infof(format string, v ...any) {
a.logger.Info(fmt.Sprintf(format, v...))
}
func (a *slogAdapter) Errorf(format string, v ...any) {
a.logger.Error(fmt.Sprintf(format, v...))
}
type FlashdutyConfig struct {
// Version of the server
Version string
// Flashduty API Base URL
BaseURL string
// Flashduty APP Key to authenticate with the Flashduty API
APPKey string
// EnabledToolsets is a list of toolsets to enable
EnabledToolsets []string
// ReadOnly indicates if we should only offer read-only tools
ReadOnly bool
// Translator provides translated text for the server tooling
Translator translations.TranslationHelperFunc
}
func NewMCPServer(cfg FlashdutyConfig) (*server.MCPServer, error) {
// When a client send an initialize request, update the user agent to include the client info.
beforeInit := func(ctx context.Context, _ any, message *mcp.InitializeRequest) {
_, client, err := getClient(ctx, cfg, cfg.Version)
if err != nil {
// Cannot return error here, just log it.
// For HTTP server, the APP key is per-request, so it might not be available
// during the initial 'initialize' call if the server doesn't provide it.
// We can log a warning and proceed. The client will be created on-demand
// during actual tool calls.
slog.Warn("Could not get client during initialization, maybe APP key is not yet available", "error", err)
return
}
userAgent := fmt.Sprintf(
"flashduty-mcp-server/%s (%s/%s)",
cfg.Version,
message.Params.ClientInfo.Name,
message.Params.ClientInfo.Version,
)
client.SetUserAgent(userAgent)
}
if len(cfg.EnabledToolsets) == 0 {
cfg.EnabledToolsets = []string{"all"}
}
toJSONString := func(v any) string {
data, err := json.Marshal(v)
if err != nil {
return fmt.Sprintf("%v", v)
}
return string(data)
}
buildLogAttrs := func(ctx context.Context, id any, method mcp.MCPMethod, extraAttrs ...any) []any {
attrs := []any{}
if tc := trace.FromContext(ctx); tc != nil {
attrs = append(attrs, "trace_id", tc.TraceID)
}
attrs = append(attrs, "id", id, "method", method)
return append(attrs, extraAttrs...)
}
hooks := &server.Hooks{
OnBeforeInitialize: []server.OnBeforeInitializeFunc{beforeInit},
OnBeforeAny: []server.BeforeAnyHookFunc{
func(ctx context.Context, _ any, _ mcp.MCPMethod, _ any) {
pkgerrors.ContextWithFlashdutyErrors(ctx)
},
func(ctx context.Context, id any, method mcp.MCPMethod, message any) {
attrs := buildLogAttrs(ctx, id, method, "params", mcplog.TruncateBodyDefault(toJSONString(message)))
slog.Info("mcp request", attrs...)
},
},
OnSuccess: []server.OnSuccessHookFunc{
func(ctx context.Context, id any, method mcp.MCPMethod, message any, result any) {
attrs := buildLogAttrs(ctx, id, method, "result", mcplog.TruncateBodyDefault(toJSONString(result)))
slog.Info("mcp response", attrs...)
},
},
OnError: []server.OnErrorHookFunc{
func(ctx context.Context, id any, method mcp.MCPMethod, message any, err error) {
attrs := buildLogAttrs(ctx, id, method, "error", err)
slog.Error("mcp error", attrs...)
},
},
}
flashdutyServer := server.NewMCPServer("flashduty-mcp-server", cfg.Version, server.WithHooks(hooks))
getClientFn := func(ctx context.Context) (context.Context, *sdk.Client, error) {
return getClient(ctx, cfg, cfg.Version)
}
// Create default toolsets
tsg := flashduty.DefaultToolsetGroup(getClientFn, cfg.ReadOnly, cfg.Translator)
err := tsg.EnableToolsets(cfg.EnabledToolsets)
if err != nil {
return nil, fmt.Errorf("failed to enable toolsets: %w", err)
}
// Register all mcp functionality with the server
tsg.RegisterAll(flashdutyServer)
return flashdutyServer, nil
}
func newStreamableHTTPServer(mcpServer *server.MCPServer, logger *slog.Logger, contextFunc server.HTTPContextFunc) *server.StreamableHTTPServer {
return server.NewStreamableHTTPServer(
mcpServer,
server.WithLogger(&slogAdapter{logger: logger}),
server.WithHTTPContextFunc(contextFunc),
)
}
type StdioServerConfig struct {
// Version of the server
Version string
// Flashduty API Base URL
BaseURL string
// Flashduty APP Key to authenticate with the Flashduty API
APPKey string
// EnabledToolsets is a list of toolsets to enable
EnabledToolsets []string
// ReadOnly indicates if we should only register read-only tools
ReadOnly bool
// OutputFormat specifies the format for tool results (json or toon)
OutputFormat string
// ExportTranslations indicates if we should export translations
ExportTranslations bool
// EnableCommandLogging indicates if we should log commands
EnableCommandLogging bool
// Path to the log file if not stderr
LogFilePath string
}
// RunStdioServer is not concurrent safe.
func RunStdioServer(cfg StdioServerConfig) error {
// Create app context
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()
// Set the global output format
flashduty.SetOutputFormat(flashduty.ParseOutputFormat(cfg.OutputFormat))
t, dumpTranslations := translations.TranslationHelper()
flashdutyServer, err := NewMCPServer(FlashdutyConfig{
Version: cfg.Version,
BaseURL: cfg.BaseURL,
APPKey: cfg.APPKey,
EnabledToolsets: cfg.EnabledToolsets,
ReadOnly: cfg.ReadOnly,
Translator: t,
})
if err != nil {
return fmt.Errorf("failed to create MCP server: %w", err)
}
if cfg.ExportTranslations {
dumpTranslations()
return nil
}
stdioServer := server.NewStdioServer(flashdutyServer)
// Setup slog logger
var slogHandler slog.Handler
if cfg.LogFilePath != "" {
file, err := os.OpenFile(cfg.LogFilePath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o600)
if err != nil {
return fmt.Errorf("failed to open log file: %w", err)
}
slogHandler = newOrderedTextHandler(file, slog.LevelDebug)
} else {
slogHandler = newOrderedTextHandler(os.Stderr, slog.LevelInfo)
}
logger := slog.New(slogHandler)
// Start listening for messages
errC := make(chan error, 1)
go func() {
in, out := io.Reader(os.Stdin), io.Writer(os.Stdout)
if cfg.EnableCommandLogging {
loggedIO := mcplog.NewIOLogger(in, out, logger)
in, out = loggedIO, loggedIO
}
// enable Flashduty errors in the context
ctx := pkgerrors.ContextWithFlashdutyErrors(ctx)
errC <- stdioServer.Listen(ctx, in, out)
}()
// Output flashduty-mcp-server string
_, _ = fmt.Fprintf(os.Stderr, "Flashduty MCP Server running on stdio\n")
// Wait for shutdown signal
select {
case <-ctx.Done():
logger.Info("shutting down server...")
case err := <-errC:
if err != nil {
return fmt.Errorf("error running server: %w", err)
}
}
return nil
}
type HTTPServerConfig struct {
// Version of the server
Version string
// Commit of the server
Commit string
// Date of the server
Date string
// Flashduty API Base URL
BaseURL string
// Port to listen on
Port string
// OutputFormat specifies the format for tool results (json or toon)
OutputFormat string
// Path to the log file if not stderr
LogFilePath string
}
// extractAppKey extracts app_key from Authorization header or query parameters
func extractAppKey(r *http.Request) string {
if authHeader := r.Header.Get("Authorization"); authHeader != "" {
tokenParts := strings.Split(authHeader, " ")
if len(tokenParts) == 2 && strings.ToLower(tokenParts[0]) == "bearer" {
return tokenParts[1]
}
}
return r.URL.Query().Get("app_key")
}
// httpContextFunc extracts configuration from the HTTP request and injects it into the context.
func httpContextFunc(ctx context.Context, r *http.Request, defaultBaseURL string) context.Context {
queryParams := r.URL.Query()
var enabledToolsets []string
if toolsets := queryParams.Get("toolsets"); toolsets != "" {
enabledToolsets = strings.Split(toolsets, ",")
}
baseURL := queryParams.Get("base_url")
if baseURL == "" {
baseURL = defaultBaseURL
}
cfg := FlashdutyConfig{
BaseURL: baseURL,
APPKey: extractAppKey(r),
EnabledToolsets: enabledToolsets,
ReadOnly: queryParams.Get("read_only") == "true",
}
return ContextWithConfig(ctx, cfg)
}
func RunHTTPServer(cfg HTTPServerConfig) error {
// Set the global output format
flashduty.SetOutputFormat(flashduty.ParseOutputFormat(cfg.OutputFormat))
// Setup slog logger
var slogHandler slog.Handler
if cfg.LogFilePath != "" {
// #nosec G304
file, err := os.OpenFile(cfg.LogFilePath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o600)
if err != nil {
return fmt.Errorf("failed to open log file: %w", err)
}
slogHandler = newOrderedTextHandler(file, slog.LevelDebug)
} else {
slogHandler = newOrderedTextHandler(os.Stderr, slog.LevelInfo)
}
logger := slog.New(slogHandler)
// Set as default logger for global slog calls
slog.SetDefault(logger)
// Create translation helper
t, _ := translations.TranslationHelper()
// Create a single MCP server instance with a default/empty config.
// The actual config will be provided per-session via the context.
mcpServer, err := NewMCPServer(FlashdutyConfig{
Version: cfg.Version,
Translator: t,
EnabledToolsets: []string{"all"},
})
if err != nil {
return fmt.Errorf("failed to create MCP server: %w", err)
}
httpServer := newStreamableHTTPServer(mcpServer, logger, func(ctx context.Context, r *http.Request) context.Context {
// Extract W3C Trace Context from HTTP headers, or generate a new one
traceCtx, err := trace.FromHTTPHeadersOrNew(r.Header)
if err != nil {
logger.Warn("Failed to generate trace context, continuing without trace", "error", err)
// Continue without trace context if generation fails
} else {
ctx = trace.ContextWithTraceContext(ctx, traceCtx)
}
// Note: HTTP request logging is handled by MCP hooks (OnBeforeAny, OnSuccess, OnError)
// which provide more detailed information including method, params, and results.
return httpContextFunc(ctx, r, cfg.BaseURL)
})
mux := http.NewServeMux()
mux.Handle("/mcp", httpServer)
mux.Handle("/flashduty", httpServer) // Keep for backward compatibility
srv := &http.Server{
Addr: ":" + cfg.Port,
Handler: mux,
ReadHeaderTimeout: 30 * time.Second,
ReadTimeout: 0, // No timeout for streaming
WriteTimeout: 0, // No timeout for streaming
IdleTimeout: 60 * time.Second, // Prevent dangling connections
MaxHeaderBytes: 128 * 1024, // 128KB
}
errC := make(chan error, 1)
go func() {
logger.Info("Server listening",
"addr", "http://0.0.0.0:"+cfg.Port,
"version", cfg.Version,
"commit", cfg.Commit,
"date", cfg.Date,
)
if err := srv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
errC <- err
}
}()
// Graceful shutdown
ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
defer stop()
// Wait for shutdown signal or server error
select {
case <-ctx.Done():
logger.Info("Shutting down server...")
case err := <-errC:
return fmt.Errorf("listen failed: %w", err)
}
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := srv.Shutdown(shutdownCtx); err != nil {
return fmt.Errorf("server shutdown failed: %w", err)
}
logger.Info("Server exited properly")
return nil
}