README
¶
Defang MCP Server
This directory hosts the Model Context Protocol (MCP) Server, equipped with Defang tools (deploy, services, destroy) to help users manage their services seamlessly using AI coding agents within supported IDEs.
Follow the guide below to get started.
Installation
Make sure you have the npm package manager installed, as npx commands are required for setup.
To connect the MCP Server to your IDE, execute the following command in your
npx -y defang@latest mcp setup --client=<your-ide>
Replace <your-ide> with the name of your preferred IDE.
After setup, you can start the MCP Server with the command:
npx -y defang@latest 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
npx -y defang@latest mcp setup --client=cursor
Windsurf
npx -y defang@latest mcp setup --client=windsurf
Codex
npx -y defang@latest mcp setup --client=codex
VS Code
npx -y defang@latest mcp setup --client=vscode
VS Code Insiders
npx -y defang@latest mcp setup --client=vscode-insiders
Claude Desktop
While this is not an IDE in the traditional sense, it can support MCP servers.
npx -y defang@latest 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.
Additional Information
For more details about the Defang MCP Server, please see our official documentation.
Documentation
¶
Index ¶
- Constants
- Variables
- func NewDefangMCPServer(version string, client MCPClient, cli agentTools.CLIInterface, ...) (*server.MCPServer, error)
- func NewMCPElicitationsController(server *server.MCPServer) *mcpElicitationsController
- func SelectMCPclients() ([]string, error)
- func SetupClient(clientStr string) error
- func SetupKnowledgeBase() error
- func ValidClientStrings() []string
- type ClientInfo
- type MCPClient
- type MCPServerConfig
- type StackConfig
- type ToolTracker
Constants ¶
const DocumentationEndpoint = "data"
Variables ¶
var AskDefangBaseURL = "https://ask.defang.io"
AskDefangBaseURL is a var so tests can override it
var KnowledgeBaseDir = client.StateDir
var ValidClients = append( []MCPClient{ MCPClientClaudeCode, MCPClientClaudeDesktop, MCPClientCodex, MCPClientCursor, MCPClientKiro, MCPClientRovo, MCPClientWindsurf, }, ValidVSCodeClients..., )
ValidClients is a list of supported MCP clients
var ValidVSCodeClients = []MCPClient{ MCPClientVSCode, MCPClientVSCodeCodespaces, MCPClientVSCodeInsiders, }
ValidVSCodeClients is a list of supported VSCode MCP clients with shorthand names
Functions ¶
func NewDefangMCPServer ¶
func NewDefangMCPServer(version string, client MCPClient, cli agentTools.CLIInterface, config StackConfig) (*server.MCPServer, error)
NewDefangMCPServer returns a new MCPServer instance with all resources, tools registered.
func SelectMCPclients ¶
SelectMCPclients prompts the user to select one or more MCP clients
func SetupClient ¶
func SetupKnowledgeBase ¶
func SetupKnowledgeBase() error
func ValidClientStrings ¶
func ValidClientStrings() []string
ValidClientStrings converts ValidClients to []string for survey options
Types ¶
type ClientInfo ¶
type ClientInfo struct {
// contains filtered or unexported fields
}
ClientInfo defines where each client stores its MCP configuration
type MCPClient ¶
type MCPClient string
MCPClient represents the supported MCP clients as an enum
const ( MCPClientClaudeCode MCPClient = "claude-code" MCPClientClaudeDesktop MCPClient = "claude-desktop" MCPClientCodex MCPClient = "codex" MCPClientCursor MCPClient = "cursor" MCPClientKiro MCPClient = "kiro" MCPClientRovo MCPClient = "rovo" MCPClientUnspecified MCPClient = "" MCPClientVSCode MCPClient = "vscode" MCPClientVSCodeCodespaces MCPClient = "vscode-codespaces" MCPClientVSCodeInsiders MCPClient = "vscode-insiders" MCPClientWindsurf MCPClient = "windsurf" )
func ParseMCPClient ¶
ParseMCPClient parses and validates the MCP client string
type MCPServerConfig ¶
type MCPServerConfig struct {
Command string `json:"command,omitempty" toml:"command,omitempty"`
Args []string `json:"args,omitempty" toml:"args,omitempty"`
Type string `json:"type,omitempty" toml:"type,omitempty"`
URL string `json:"url,omitempty" toml:"url,omitempty"`
Env map[string]string `json:"env,omitempty" toml:"env,omitempty"`
EnvFile string `json:"envFile,omitempty" toml:"envFile,omitempty"`
Headers map[string]string `json:"headers,omitempty" toml:"headers,omitempty"`
}
MCPServerConfig represents the configuration for an MCP server
type StackConfig ¶
type StackConfig = tools.StackConfig
type ToolTracker ¶
type ToolTracker struct {
// contains filtered or unexported fields
}
func (*ToolTracker) TrackTool ¶
func (t *ToolTracker) TrackTool(name string, handler server.ToolHandlerFunc) server.ToolHandlerFunc
Source Files
Directories