Skip to content

Add @latest to mcp readme #1125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 21, 2025
Merged

Add @latest to mcp readme #1125

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40da195
add @latest to mcp readme
commit111 Apr 21, 2025
5e1faed
add vs code insiders
commit111 Apr 21, 2025
5949336
link to docs page
commit111 Apr 21, 2025
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
32 changes: 18 additions & 14 deletions src/pkg/mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

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

Below is an installation guide to get started.
Follow the guide below 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.
Make sure 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.

Connect the MCP server with your IDE by running the following command in your terminal:
To connect the MCP Server to your IDE, execute the following command in your

```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).
Replace `<your-ide>` with the name of your [preferred IDE](#supported-ides).

After setup, you can start the MCP server with the command:
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 server is running, you can access the Defang MCP tools directly through the AI agent chat in your IDE.
Expand All @@ -31,27 +31,27 @@ Once the server is running, you can access the Defang MCP tools directly through
### Cursor

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

### Windsurf

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

### VSCode
### VS Code / VS Code Insiders

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

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

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

## MCP Tools
Expand All @@ -69,3 +69,7 @@ The `services` tool displays the details of all your services that are currently
### `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](https://docs.defang.io/docs/concepts/mcp).
Loading