Skip to content
Merged
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
35 changes: 23 additions & 12 deletions docs/concepts/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,54 +20,65 @@ This page is a guide to the Defang MCP Server detailing its installation, tools,

## Installation

First, make sure you have the [npm package manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed so that you can use `npx` commands.
Ensure that you have the [npm package manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed, as `npx` commands are required for setup.

:::warning
At this time, the Defang MCP Server can only be installed using `npx`. Other methods are not yet supported.
:::

Connect the Defang MCP Server with your IDE by running the following command in your terminal:

```bash
npx -y defang mcp setup --client=<your-ide>
npx -y defang@latest 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:
Replace `<your-ide>` with the name of your [preferred IDE](#supported-ides). After setup, you can start the MCP Server with the command:

```bash
npx -y defang mcp serve
npx -y defang@latest mcp serve
```

Once the MCP Server is running, you can access the Defang MCP tools directly through the AI agent chat in your IDE.

![IDE Screenshot](/img/mcp-concept/ide.png)

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.

## Supported IDEs

### Cursor

```bash
npx -y defang mcp setup --client=cursor
npx -y defang@latest mcp setup --client=cursor
```

![Cursor](/img/mcp-concept/cursor.png)

### Windsurf

```bash
npx -y defang mcp setup --client=windsurf
npx -y defang@latest mcp setup --client=windsurf
```

### VS Code
![Windsurf](/img/mcp-concept/windsurf.png)

### VS Code / VS Code Insiders


```bash
npx -y defang mcp setup --client=vscode
npx -y defang@latest mcp setup --client=vscode
```

![VS Code](/img/mcp-concept/vscode.png)

### Claude Desktop

(While this is not an IDE in the traditional sense, it can support MCP servers.)
While this is not an IDE in the traditional sense, it can support MCP servers. For a smoother experience, consider specifying a project name or directory when making chat prompts to this platform.

```bash
npx -y defang mcp setup --client=claude
npx -y defang@latest mcp setup --client=claude
```

![Claude Desktop](/img/mcp-concept/claude.png)

## MCP Tools

Below are the tools available in the Defang MCP Server.
Expand Down
Binary file added static/img/mcp-concept/claude.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/mcp-concept/vscode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/mcp-concept/windsurf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.