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
60 changes: 54 additions & 6 deletions docs/concepts/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,25 +114,39 @@ While this is not an IDE in the traditional sense, it can support MCP servers. F
Setup command:

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

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.png)
![Claude Desktop](/img/mcp-concept/claude-desktop.png)

### Claude Code

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.

Setup command:

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

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)

## MCP Tools

Below are the tools available in the Defang MCP Server.

:::info[Prerequisite]
In order to use any of the MCP tools, you must set a provider using one of the [MCP prompts](#mcp-prompts) first.
:::

### `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.

:::info
The Defang MCP Server currently supports deployments to [Defang Playground](/docs/providers/playground). We plan to support BYOC in future updates.
:::

### `services`

The `services` tool displays the details of all your services that are currently deployed in your project 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.
Expand All @@ -157,6 +171,40 @@ The `set_config` tool will [set](/docs/tutorials/configure-environment-variables

The `remove_config` tool will [remove](/docs/tutorials/configure-environment-variables#removing-a-config-value) a specific Defang config for your project.

## MCP Prompts

Below are the [prompts](https://modelcontextprotocol.io/specification/2025-06-18/server/prompts) available in the Defang MCP Server.

### `defang.AWS_Setup`

The `defang.AWS_Setup` prompt helps you set up your AWS credentials for deploying services to AWS using Defang. Please read this [guide](../tutorials/deploying-with-the-defang-mcp-server#aws) on how to use this prompt.

:::note
Credentials never leave memory and are automatically cleared after you close your IDE.
:::

Arguments:

- AWS Credential - REQUIRED : Will take a profile name if using an AWS profile, or an Access Key ID if using Access Keys.
- AWS_SECRET_ACCESS_KEY - REQUIRED for Access Keys method: Leave blank if using an AWS profile.
- AWS_REGION - REQUIRED or OPTIONAL : Required if using Access Keys method, optional if using an AWS profile.

### `defang.GCP_Setup`

The `defang.GCP_Setup` prompt helps you set up your targeted GCP project for deploying services to GCP using Defang. Please read this [guide](../tutorials/deploying-with-the-defang-mcp-server#gcp) on how to use this prompt.

Arguments:

- GCP Project ID - REQUIRED : The ID of the GCP project you want to use (e.g., "my-gcp-project").

### `defang.Playground_Setup`

The `defang.Playground_Setup` prompt helps you set up Defang Playground as your deployment provider. Please read this [guide](../tutorials/deploying-with-the-defang-mcp-server#playground) on how to use this prompt.

Arguments:

- No arguments required

## Example Prompts

After connecting the Defang MCP Server to your IDE using an installation method, you can type in prompts in your chat to invoke the AI agent to use any MCP tool(s).
Expand Down
4 changes: 4 additions & 0 deletions docs/tutorials/deploying-with-the-defang-mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Open your chat window and type `/defang.AWS_Setup`, or select the corresponding

The [MCP prompt](https://modelcontextprotocol.io/specification/2025-06-18/server/prompts) accepts two types of credentials:

:::note
Credentials never leave memory and are automatically cleared after you close your IDE.
:::

1. Method 1 - Using an AWS Profile:
The following prompt will have three arguments and only the first argument is required:

Expand Down
Binary file added static/img/mcp-concept/claude-code.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 modified static/img/mcp-concept/diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.