diff --git a/cmd/mcp/helpers.go b/cmd/mcp/helpers.go index fffea4d2a4..b6595a1dd6 100644 --- a/cmd/mcp/helpers.go +++ b/cmd/mcp/helpers.go @@ -1,6 +1,10 @@ package mcp -import sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" +import ( + "fmt" + + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" +) // opResultHandler is the standard (errorResult | opOK) wrapper for void operations. // It calls fn and returns either an error result or opOK{OK: true}. @@ -10,3 +14,11 @@ func opResultHandler(fn func() error) (*sdkmcp.CallToolResult, opOK, error) { } return nil, opOK{OK: true}, nil } + +// requireField returns the validation error for an empty required tool input. +func requireField(field, value string) error { + if value == "" { + return fmt.Errorf("%s is required", field) + } + return nil +} diff --git a/cmd/mcp/helpers_test.go b/cmd/mcp/helpers_test.go index 1874bb7a80..88ee62e779 100644 --- a/cmd/mcp/helpers_test.go +++ b/cmd/mcp/helpers_test.go @@ -39,3 +39,32 @@ func TestOpResultHandler_Error(t *testing.T) { t.Fatalf("error path must leave ok zero") } } + +const requireFieldName = "name" + +func TestRequireField(t *testing.T) { + tests := []struct { + name string + field string + value string + wantErr string + }{ + {name: "empty name", field: requireFieldName, value: "", wantErr: "name is required"}, + {name: "empty source", field: "source", value: "", wantErr: "source is required"}, + {name: "non-empty value passes", field: requireFieldName, value: "ws-1", wantErr: ""}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + err := requireField(tt.field, tt.value) + if tt.wantErr == "" { + if err != nil { + t.Fatalf("requireField(%q, %q) = %v, want nil", tt.field, tt.value, err) + } + return + } + if err == nil || err.Error() != tt.wantErr { + t.Fatalf("requireField(%q, %q) = %v, want %q", tt.field, tt.value, err, tt.wantErr) + } + }) + } +} diff --git a/cmd/mcp/tools_provider.go b/cmd/mcp/tools_provider.go index 6038a7468e..21c279e71e 100644 --- a/cmd/mcp/tools_provider.go +++ b/cmd/mcp/tools_provider.go @@ -58,8 +58,8 @@ func registerProviderTools(s *sdkmcp.Server, g *flags.GlobalFlags) { }, safeHandler(func( ctx context.Context, _ *sdkmcp.CallToolRequest, in providerAddInput, ) (*sdkmcp.CallToolResult, opOK, error) { - if in.Source == "" { - return errorResult(fmt.Errorf("source is required")), opOK{}, nil + if err := requireField("source", in.Source); err != nil { + return errorResult(err), opOK{}, nil } return opResultHandler(func() error { return runProviderAdd(ctx, g, in) }) })) @@ -70,8 +70,8 @@ func registerProviderTools(s *sdkmcp.Server, g *flags.GlobalFlags) { }, safeHandler(func( ctx context.Context, _ *sdkmcp.CallToolRequest, in providerNameInput, ) (*sdkmcp.CallToolResult, opOK, error) { - if in.Name == "" { - return errorResult(fmt.Errorf("name is required")), opOK{}, nil + if err := requireField("name", in.Name); err != nil { + return errorResult(err), opOK{}, nil } return opResultHandler(func() error { return runProviderDelete(ctx, g, in.Name) }) })) @@ -84,8 +84,8 @@ func registerProviderTools(s *sdkmcp.Server, g *flags.GlobalFlags) { }, safeHandler(func( ctx context.Context, _ *sdkmcp.CallToolRequest, in providerNameInput, ) (*sdkmcp.CallToolResult, opOK, error) { - if in.Name == "" { - return errorResult(fmt.Errorf("name is required")), opOK{}, nil + if err := requireField("name", in.Name); err != nil { + return errorResult(err), opOK{}, nil } return opResultHandler(func() error { return runProviderUse(ctx, g, in.Name) }) })) diff --git a/cmd/mcp/tools_workspace.go b/cmd/mcp/tools_workspace.go index 52ffbfee35..64b500b924 100644 --- a/cmd/mcp/tools_workspace.go +++ b/cmd/mcp/tools_workspace.go @@ -2,7 +2,6 @@ package mcp import ( "context" - "fmt" "time" "github.com/devsy-org/devsy/cmd/flags" @@ -90,22 +89,29 @@ func handleWorkspaceList(ctx context.Context, g *flags.GlobalFlags) (workspaceLi } func handleWorkspaceStatus(ctx context.Context, g *flags.GlobalFlags, name string) (any, error) { - if name == "" { - return nil, fmt.Errorf("name is required") + if err := requireField("name", name); err != nil { + return nil, err } + ws, err := getWorkspaceClient(ctx, g, name) + if err != nil { + return nil, err + } + return ws.WorkspaceConfig(), nil +} + +// getWorkspaceClient loads the devsy config and resolves an existing workspace by name. +func getWorkspaceClient( + ctx context.Context, g *flags.GlobalFlags, name string, +) (client2.BaseWorkspaceClient, error) { devsyConfig, err := config.LoadConfig(g.Context, g.Provider) if err != nil { return nil, err } - client, err := workspace.Get(ctx, workspace.GetOptions{ + return workspace.Get(ctx, workspace.GetOptions{ DevsyConfig: devsyConfig, Args: []string{name}, Owner: g.Owner, }) - if err != nil { - return nil, err - } - return client.WorkspaceConfig(), nil } // errorResult builds an isError CallToolResult carrying the classified payload. @@ -154,8 +160,8 @@ func registerWorkspaceStartTool(s *sdkmcp.Server, g *flags.GlobalFlags, sem *opS }, safeHandler(func( ctx context.Context, req *sdkmcp.CallToolRequest, in nameInput, ) (*sdkmcp.CallToolResult, opOK, error) { - if in.Name == "" { - return errorResult(fmt.Errorf("name is required")), opOK{}, nil + if err := requireField("name", in.Name); err != nil { + return errorResult(err), opOK{}, nil } release, err := sem.acquire(ctx) if err != nil { @@ -177,8 +183,8 @@ func registerWorkspaceStopTool(s *sdkmcp.Server, g *flags.GlobalFlags) { }, safeHandler(func( ctx context.Context, _ *sdkmcp.CallToolRequest, in nameInput, ) (*sdkmcp.CallToolResult, opOK, error) { - if in.Name == "" { - return errorResult(fmt.Errorf("name is required")), opOK{}, nil + if err := requireField("name", in.Name); err != nil { + return errorResult(err), opOK{}, nil } return opResultHandler(func() error { return stopWorkspace(ctx, g, in.Name) }) })) @@ -192,8 +198,8 @@ func registerWorkspaceDeleteTool(s *sdkmcp.Server, g *flags.GlobalFlags) { }, safeHandler(func( ctx context.Context, _ *sdkmcp.CallToolRequest, in nameInput, ) (*sdkmcp.CallToolResult, opOK, error) { - if in.Name == "" { - return errorResult(fmt.Errorf("name is required")), opOK{}, nil + if err := requireField("name", in.Name); err != nil { + return errorResult(err), opOK{}, nil } return opResultHandler(func() error { return deleteWorkspace(ctx, g, in.Name, in.Force) }) })) @@ -215,8 +221,8 @@ func registerWorkspaceCreateTool(s *sdkmcp.Server, g *flags.GlobalFlags, sem *op }, safeHandler(func( ctx context.Context, req *sdkmcp.CallToolRequest, in createInput, ) (*sdkmcp.CallToolResult, any, error) { - if in.Source == "" { - return errorResult(fmt.Errorf("source is required")), nil, nil + if err := requireField("source", in.Source); err != nil { + return errorResult(err), nil, nil } release, err := sem.acquire(ctx) if err != nil { @@ -240,34 +246,18 @@ func startWorkspace(ctx context.Context, g *flags.GlobalFlags, name string) erro // RunFromOptions creates the workspace if the name doesn't resolve; // pre-check existence to keep workspace_start lookup-only. A TOCTOU race // with a concurrent delete surfaces as an actionable error. - devsyConfig, err := config.LoadConfig(g.Context, g.Provider) - if err != nil { - return err - } - if _, err := workspace.Get(ctx, workspace.GetOptions{ - DevsyConfig: devsyConfig, - Args: []string{name}, - Owner: g.Owner, - }); err != nil { + if _, err := getWorkspaceClient(ctx, g, name); err != nil { return err } return runUp(ctx, g, createInput{Source: name}) } func stopWorkspace(ctx context.Context, g *flags.GlobalFlags, name string) error { - devsyConfig, err := config.LoadConfig(g.Context, g.Provider) - if err != nil { - return err - } - client, err := workspace.Get(ctx, workspace.GetOptions{ - DevsyConfig: devsyConfig, - Args: []string{name}, - Owner: g.Owner, - }) + ws, err := getWorkspaceClient(ctx, g, name) if err != nil { return err } - return client.Stop(ctx, client2.StopOptions{}) + return ws.Stop(ctx, client2.StopOptions{}) } func deleteWorkspace(ctx context.Context, g *flags.GlobalFlags, name string, force bool) error { @@ -285,29 +275,18 @@ func deleteWorkspace(ctx context.Context, g *flags.GlobalFlags, name string, for } func createWorkspace(ctx context.Context, g *flags.GlobalFlags, in createInput) (any, error) { - if in.Source == "" { - return nil, fmt.Errorf("source is required") - } if err := runUp(ctx, g, in); err != nil { return nil, err } - devsyConfig, err := config.LoadConfig(g.Context, g.Provider) - if err != nil { - return nil, err - } lookup := in.Name if lookup == "" { lookup = in.Source } - client, err := workspace.Get(ctx, workspace.GetOptions{ - DevsyConfig: devsyConfig, - Args: []string{lookup}, - Owner: g.Owner, - }) + ws, err := getWorkspaceClient(ctx, g, lookup) if err != nil { return nil, err } - return client.WorkspaceConfig(), nil + return ws.WorkspaceConfig(), nil } func runUp(ctx context.Context, g *flags.GlobalFlags, in createInput) error { diff --git a/cmd/mcp/tools_workspace_test.go b/cmd/mcp/tools_workspace_test.go new file mode 100644 index 0000000000..3905a0321d --- /dev/null +++ b/cmd/mcp/tools_workspace_test.go @@ -0,0 +1,30 @@ +package mcp + +import ( + "context" + "path/filepath" + "testing" + + "github.com/devsy-org/devsy/cmd/flags" + "github.com/devsy-org/devsy/pkg/config" +) + +func TestGetWorkspaceClient_UnknownNameReturnsError(t *testing.T) { + t.Setenv(config.EnvHome, t.TempDir()) + t.Setenv(config.EnvConfig, filepath.Join(t.TempDir(), "config.yaml")) + + client, err := getWorkspaceClient(context.Background(), &flags.GlobalFlags{}, "missing-ws") + if err == nil { + t.Fatalf("getWorkspaceClient for an unknown workspace name must return an error") + } + if client != nil { + t.Fatalf("getWorkspaceClient for an unknown workspace name must return a nil client") + } +} + +func TestHandleWorkspaceStatus_EmptyNameReturnsError(t *testing.T) { + _, err := handleWorkspaceStatus(context.Background(), &flags.GlobalFlags{}, "") + if err == nil || err.Error() != "name is required" { + t.Fatalf("handleWorkspaceStatus with empty name = %v, want \"name is required\"", err) + } +}