Import MCP Server with mcp commands (#1118)

* Import MCP Server

This was imported from the repo
[here](https://github.com/DefangLabs/defang-mcp)

* Made basic CLI command for mcp

Added the command mcp and subcommands, [serve, setup]

* Implemented the MCP commands serve and setup

- mcp serve will satrt the MCP server
- mcp setup will create the MCP configuration file,
current only supporting vscode, windsurf, cursor and claude

* Made MCP cilents process controls

Added a way to restart the MCP client process.

* Remove logger

Cannot use logger due to it tapping into the stdio
and does not match with json-rpc format.

* Added log file

* write kb to user state dir

* Run from npx

* update vendor hash

* edit mcp folder readme

* remove knowledge_base files

* avoid changing directory when starting mcp server

* remove mcp login tool from readme

* avoid trying to automatically restart the mcp client

* ensure client is lowercase before matching

* inline GetValidClientsString

* Minor updates

Minor review updates

* ensure client is lowercase

* tighten up IsValidClient

* factor out SetupMCPClient func

* extract pkg/mcp/setup.go

* Update description

Co-authored-by: Eric Liu <[email protected]>

* read kb and samples_examples from state dir

* remove unused output buffer

* remove redundant error logging

* remove redundant log message

* clean up

Co-authored-by: Eric Liu <[email protected]>

* Refactor Login and share parent resources

* update installation to npx

* Kevin Merge

* Blocking auth github fix

We need to do this because when we start the server
the broswer will open and does populate with the
correct url but the server will not be able to
start. By doing this we are able to open the broswer
and not be blocked by the server.

* update config to use npx

---------

Co-authored-by: KevyVo <[email protected]>
Co-authored-by: Jordan Stephens <[email protected]>
Co-authored-by: Eric Liu <[email protected]>
Co-authored-by: commit111 <[email protected]>
Co-authored-by: Eric Liu <[email protected]>

Author: 5 people

pkgs/defang/cli.nix

@@ -7,13 +7,13 @@ buildGoModule {
   pname = "defang-cli";
   version = "git";
   src = ../../src;
-  vendorHash = "sha256-Q2dwaHlxzbJBMTuIKiLmJNdT0LfoHgmTOHprFTK3BTc=";
+  vendorHash = "sha256-wy6S3alGpeXveCPR8BnyaGcsIHzgclv3yrofwE5X3oI="; # TODO: use fetchFromGitHub
 
   subPackages = [ "cmd/cli" ];
 
   nativeBuildInputs = [ installShellFiles ];
 
-  CGO_ENABLED = 0;
+  env.CGO_ENABLED = 0;
   ldflags = [
     "-s"
     "-w"

src/.gitignore

@@ -9,3 +9,5 @@ defang-arm64
 dist/
 distx/
 defang.exe
+samples_examples.json
+knowledge_base.json

src/cmd/cli/command/commands.go

@@ -269,6 +269,13 @@ func SetupCommands(ctx context.Context, version string) {
 	deploymentsCmd.AddCommand(deploymentsListCmd)
 	RootCmd.AddCommand(deploymentsCmd)
 
+	// MCP Command
+	mcpCmd.AddCommand(mcpSetupCmd)
+	mcpCmd.AddCommand(mcpServerCmd)
+	mcpSetupCmd.Flags().String("client", "", "MCP setup client (supports: claude, windsurf, cursor, vscode)")
+	mcpSetupCmd.MarkFlagRequired("client")
+	RootCmd.AddCommand(mcpCmd)
+
 	// Send Command
 	sendCmd.Flags().StringP("subject", "n", "", "subject to send the message to (required)")
 	sendCmd.Flags().StringP("type", "t", "", "type of message to send (required)")

src/cmd/cli/command/mcp.go

@@ -0,0 +1,91 @@
+package command
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+
+	cliClient "github.com/DefangLabs/defang/src/pkg/cli/client"
+	"github.com/DefangLabs/defang/src/pkg/mcp"
+	"github.com/DefangLabs/defang/src/pkg/mcp/resources"
+	"github.com/DefangLabs/defang/src/pkg/mcp/tools"
+	"github.com/DefangLabs/defang/src/pkg/term"
+	"github.com/mark3labs/mcp-go/server"
+	"github.com/spf13/cobra"
+)
+
+var mcpCmd = &cobra.Command{
+	Use:         "mcp",
+	Short:       "Manage MCP Server for defang",
+	Annotations: authNeededAnnotation,
+}
+
+var mcpServerCmd = &cobra.Command{
+	Use:         "serve",
+	Short:       "Start defang MCP server",
+	Annotations: authNeededAnnotation,
+	Args:        cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+
+		logFile, err := os.OpenFile(filepath.Join(cliClient.StateDir, "defang-mcp.log"), os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
+		if err != nil {
+			term.Error("Failed to open log file", "error", err)
+			return err
+		}
+		defer logFile.Close()
+
+		// TODO: Should we still write to a file or we can go back to stderr
+		term.DefaultTerm = term.NewTerm(os.Stdin, logFile, logFile)
+
+		// Setup knowledge base
+		if err := mcp.SetupKnowledgeBase(); err != nil {
+			term.Error("Failed to setup knowledge base", "error", err)
+			return err
+		}
+
+		term.Info("Starting Defang MCP server")
+
+		// Create a new MCP server
+		term.Info("Creating MCP server")
+		s := server.NewMCPServer(
+			"Defang Services",
+			"1.0.0",
+			server.WithResourceCapabilities(true, true), // Enable resource management and notifications
+			server.WithPromptCapabilities(true),         // Enable interactive prompts
+			server.WithToolCapabilities(true),           // Enable dynamic tool list updates
+			server.WithInstructions("You are an MCP server for Defang Services. Your role is to manage and deploy services efficiently using the provided tools and resources."),
+		)
+
+		// Setup resources
+		resources.SetupResources(s)
+
+		// Setup tools
+		tools.SetupTools(s, client, getCluster(), gitHubClientId)
+
+		// Start the server
+		term.Info("Starting Defang Services MCP server")
+		if err := server.ServeStdio(s); err != nil {
+			return err
+		}
+
+		term.Info("Server shutdown")
+
+		return nil
+	},
+}
+
+var mcpSetupCmd = &cobra.Command{
+	Use:         "setup",
+	Short:       "Setup MCP client for defang mcp server",
+	Annotations: authNeededAnnotation,
+	Args:        cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		client, _ := cmd.Flags().GetString("client")
+		client = strings.ToLower(client)
+		if err := mcp.SetupClient(client); err != nil {
+			return err
+		}
+
+		return nil
+	},
+}

src/go.mod

@@ -36,6 +36,7 @@ require (
 	github.com/gorilla/websocket v1.5.0
 	github.com/hashicorp/go-retryablehttp v0.7.7
 	github.com/hexops/gotextdiff v1.0.3
+	github.com/mark3labs/mcp-go v0.21.0
 	github.com/miekg/dns v1.1.59
 	github.com/moby/patternmatcher v0.6.0
 	github.com/muesli/termenv v0.15.2
@@ -93,6 +94,7 @@ require (
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/rivo/uniseg v0.4.2 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/yosida95/uritemplate/v3 v3.0.2 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/contrib/detectors/gcp v1.29.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.54.0 // indirect

src/go.sum

@@ -239,6 +239,8 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
+github.com/mark3labs/mcp-go v0.21.0 h1:oyEtiXg8PnrVEFis9b1AwbiUWF2dTbyBP5yLo7SruXE=
+github.com/mark3labs/mcp-go v0.21.0/go.mod h1:KmJndYv7GIgcPVwEKJjNcbhVQ+hJGJhrCCB/9xITzpE=
 github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
@@ -314,6 +316,8 @@ github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 h1:EzJWgHo
 github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ=
 github.com/xeipuuv/gojsonschema v1.2.0 h1:LhYJRs+L4fBtjZUfuSZIKGeVu0QRy8e5Xi7D17UxZ74=
 github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y=
+github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
+github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=

src/pkg/cli/login.go

@@ -47,7 +47,7 @@ func (g GitHubAuthService) login(
 ) (string, error) {
 	term.Debug("Logging in to", fabric)
 
-	code, err := github.StartAuthCodeFlow(ctx, gitHubClientId)
+	code, err := github.StartAuthCodeFlow(ctx, gitHubClientId, true)
 	if err != nil {
 		return "", err
 	}

src/pkg/cli/token.go

@@ -17,7 +17,7 @@ func Token(ctx context.Context, client client.FabricClient, clientId string, ten
 		return ErrDryRun
 	}
 
-	code, err := github.StartAuthCodeFlow(ctx, clientId)
+	code, err := github.StartAuthCodeFlow(ctx, clientId, false)
 	if err != nil {
 		return err
 	}

src/pkg/github/auth.go

@@ -56,8 +56,9 @@ var (
 	authTemplate = template.Must(template.New("auth").Parse(authTemplateString))
 )
 
-func StartAuthCodeFlow(ctx context.Context, clientId string) (string, error) {
+func StartAuthCodeFlow(ctx context.Context, clientId string, prompt bool) (string, error) {
 	ctx, cancel := context.WithCancel(ctx)
+	defer cancel()
 
 	// Generate random state
 	state := uuid.NewString()
@@ -102,25 +103,29 @@ func StartAuthCodeFlow(ctx context.Context, clientId string) (string, error) {
 	}
 	authorizeUrl = "https://github.com/login/oauth/authorize?" + values.Encode()
 
-	n, _ := term.Printf("Please visit %s and log in. (Right click the URL or press ENTER to open browser)\r", server.URL)
-	defer term.Print(strings.Repeat(" ", n), "\r") // TODO: use termenv to clear line
-
-	input := term.NewNonBlockingStdin()
-	defer input.Close() // abort the read
-	go func() {
-		var b [1]byte
-		for {
-			if _, err := input.Read(b[:]); err != nil {
-				return // exit goroutine
-			}
-			switch b[0] {
-			case 3: // Ctrl-C
-				cancel()
-			case 10, 13: // Enter or Return
-				browser.OpenURL(server.URL)
+	// TODO:This is used to open the browser for GitHub Auth before blocking
+	if !prompt {
+		browser.OpenURL(server.URL)
+	} else {
+		n, _ := term.Printf("Please visit %s and log in. (Right click the URL or press ENTER to open browser)\r", server.URL)
+		defer term.Print(strings.Repeat(" ", n), "\r") // TODO: use termenv to clear line
+		input := term.NewNonBlockingStdin()
+		defer input.Close() // abort the read
+		go func() {
+			var b [1]byte
+			for {
+				if _, err := input.Read(b[:]); err != nil {
+					return // exit goroutine
+				}
+				switch b[0] {
+				case 3: // Ctrl-C
+					cancel()
+				case 10, 13: // Enter or Return
+					browser.OpenURL(server.URL)
+				}
 			}
-		}
-	}()
+		}()
+	}
 
 	select {
 	case <-ctx.Done():

src/pkg/mcp/README.md

@@ -0,0 +1,71 @@
+# ![Defang](https://raw.githubusercontent.com/DefangLabs/defang-assets/main/Logos/Element_Wordmark_Slogan/JPG/Dark_Colour_Glow.jpg)
+
+# Defang MCP Server
+
+This folder contains a Model Context Protocol (MCP) server with built-in Defang tools (`deploy`, `services`, `destroy`) to allow users to manage their services with AI coding agents in a supported IDE.
+
+Below is an installation guide to get started.
+
+## Installation
+
+First, make sure you have the [npm package manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed.
+
+Connect the MCP server with your IDE by running the following command in your terminal:
+
+```bash
+npx -y defang mcp setup --client=<your-ide>
+```
+
+Replace `<your-ide>` with the name of your preferred IDE. See our list of [Supported IDEs](#supported-ides).
+
+After setup, you can start the MCP server with the command:
+
+```bash
+npx -y defang mcp serve
+```
+
+Once the server is running, you can access the Defang MCP tools directly through the AI agent chat in your IDE.
+
+## Supported IDEs
+
+### Cursor
+
+```bash
+npx -y defang mcp setup --client=cursor
+```
+
+### Windsurf
+
+```bash
+npx -y defang mcp setup --client=windsurf
+```
+
+### VSCode
+
+```bash
+npx -y defang mcp setup --client=vscode
+```
+
+### Claude Desktop
+
+(While this is not an IDE in the traditional sense, it can support MCP servers.)
+
+```bash
+npx -y defang mcp setup --client=claude
+```
+
+## MCP Tools
+
+Below are the tools available in the Defang MCP Server.
+
+### `deploy`
+
+The `deploy` tool scans your project directory for Dockerfiles and `compose.yaml` files, then deploys the detected service(s) using Defang. You can monitor the deployment process in the Defang Portal.
+
+### `services`
+
+The `services` tool displays the details of all your services that are currently deployed with Defang. It shows the Service Name, Deployment ID, Public URL and Service Status. If there are no services found, it will display an appropriate message.
+
+### `destroy`
+
+Given a project name or directory, the `destroy` tool identifies any services deployed with Defang and terminates them. If no services are found, it will display an appropriate message.

src/pkg/mcp/deployment_info/deployment_info.go

@@ -0,0 +1,54 @@
+package deployment_info
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/DefangLabs/defang/src/pkg/cli/client"
+	"github.com/DefangLabs/defang/src/pkg/term"
+	defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
+)
+
+type ErrNoServices struct {
+	ProjectName string // may be empty
+}
+
+func (e ErrNoServices) Error() string {
+	return fmt.Sprintf("no services found in project %q", e.ProjectName)
+}
+
+type Service struct {
+	Service      string
+	DeploymentId string
+	PublicFqdn   string
+	PrivateFqdn  string
+	Status       string
+}
+
+func GetServices(ctx context.Context, projectName string, provider client.Provider) ([]Service, error) {
+	term.Infof("Listing services in project %q", projectName)
+
+	getServicesResponse, err := provider.GetServices(ctx, &defangv1.GetServicesRequest{Project: projectName})
+	if err != nil {
+		return nil, err
+	}
+
+	numServices := len(getServicesResponse.Services)
+
+	if numServices == 0 {
+		return nil, ErrNoServices{ProjectName: projectName}
+	}
+
+	result := make([]Service, numServices)
+	for i, si := range getServicesResponse.Services {
+		result[i] = Service{
+			Service:      si.Service.Name,
+			DeploymentId: si.Etag,
+			PublicFqdn:   si.PublicFqdn,
+			PrivateFqdn:  si.PrivateFqdn,
+			Status:       si.Status,
+		}
+	}
+
+	return result, nil
+}