Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 36 additions & 8 deletions docs/concepts/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ Run the setup command in your terminal for your IDE of choice from the [Supporte
Install the [Defang CLI](/docs/getting-started.mdx#install-the-defang-cli) using [Curl](https://curl.se/) or [Homebrew](https://brew.sh/)

```bash
defang mcp setup --client=<your-ide>
defang mcp setup
```

An interactive prompt will appear asking you to select your IDE(s) from a list of supported IDE(s). Select your IDE(s) by using the spacebar and arrow keys to navigate and press enter to confirm your selection.
![Picker](/img/mcp-concept/mcp-picker.png)

Please ensure that your selected IDE(s) are updated to the latest version to ensure compatibility.
:::

Once the command completes, you may need to restart your IDE for the changes to take effect.
Expand All @@ -39,6 +43,12 @@ Once the MCP Server is running, you can access the Defang MCP tools directly thr

That's it! Feel free to explore our [Example Prompts](#example-prompts) to get ideas on how to interact with the AI agent and make the most of the Defang MCP Server.

Note that we still support the previous client selection method using `--client=<your-ide>` flag.

```bash
defang mcp setup --client=<your-ide>
```

Note that `npx` installation is supported, but not recommended.

```bash
Expand All @@ -52,9 +62,11 @@ npx -y defang@latest mcp setup --client=<your-ide>
Setup command:

```bash
defang mcp setup --client=cursor
defang mcp setup
```

Select `cursor` from the [interactive prompt](#installation).

Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:

![Cursor](/img/mcp-concept/cursor.png)
Expand All @@ -64,9 +76,15 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
Setup command:

```bash
defang mcp setup --client=windsurf
defang mcp setup
```

Select `windsurf` from the [interactive prompt](#installation).

:::warning
Windsurf currently does not support [MCP prompts](https://docs.windsurf.com/windsurf/cascade/mcp#general-information), therefore BYOC providers (AWS, GCP) cannot be set up through Windsurf. You can still use Playground as your deployment provider or setup AWS/GCP using the Defang CLI or another supported IDE.
:::

Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:

![Windsurf](/img/mcp-concept/windsurf.png)
Expand All @@ -76,9 +94,11 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
Setup command:

```bash
defang mcp setup --client=vscode
defang mcp setup
```

Select `vscode` from the [interactive prompt](#installation).

Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:

![VS Code](/img/mcp-concept/vscode.png)
Expand All @@ -88,9 +108,11 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
Setup command:

```bash
defang mcp setup --client=vscode-insiders
defang mcp setup
```

Select `vscode-insiders` from the [interactive prompt](#installation).

Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:

![VS Code](/img/mcp-concept/vscode-insiders.png)
Expand All @@ -100,9 +122,11 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
Setup command:

```bash
defang mcp setup --client=kiro
defang mcp setup
```

Select `kiro` from the [interactive prompt](#installation).

Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:

![Kiro](/img/mcp-concept/kiro.png)
Expand All @@ -114,9 +138,11 @@ While this is not an IDE in the traditional sense, it can support MCP servers. F
Setup command:

```bash
defang mcp setup --client=claude-desktop
defang mcp setup
```

Select `claude-desktop` from the [interactive prompt](#installation).

Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:

![Claude Desktop](/img/mcp-concept/claude-desktop.png)
Expand All @@ -128,9 +154,11 @@ While this is not an IDE in the traditional sense, it can support MCP servers. F
Setup command:

```bash
defang mcp setup --client=claude-code
defang mcp setup
```

Select `claude-code` from the [interactive prompt](#installation).

Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:

![Claude Code](/img/mcp-concept/claude-code.png)
Expand Down
Binary file added static/img/mcp-concept/mcp-picker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.