Skip to content

Commit 385d473

Browse files
committed
docs: update demo README with correct install instructions and MCP tools
1 parent c1f5f6a commit 385d473

File tree

1 file changed

+76
-20
lines changed

1 file changed

+76
-20
lines changed

cli/demo/README.md

Lines changed: 76 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,58 @@
1-
# azd-app Demo Project
1+
# azd app Demo Project
22

3-
This demo project showcases how to use azd-app with AI-powered debugging through the MCP (Model Context Protocol) integration with GitHub Copilot.
3+
This demo project showcases how to use `azd app` with AI-powered debugging through the MCP (Model Context Protocol) integration with GitHub Copilot.
4+
5+
> 📚 **Full Documentation**: [jongio.github.io/azd-app](https://jongio.github.io/azd-app/)
6+
7+
## Prerequisites
8+
9+
You'll need the Azure Developer CLI (azd) installed. Choose your platform:
10+
11+
**Windows:**
12+
```bash
13+
winget install microsoft.azd
14+
```
15+
16+
**macOS:**
17+
```bash
18+
brew tap azure/azd && brew install azd
19+
```
20+
21+
**Linux:**
22+
```bash
23+
curl -fsSL https://aka.ms/install-azd.sh | bash
24+
```
25+
26+
## Install azd app
27+
28+
Enable the azd extensions feature and install the azd app extension:
29+
30+
```bash
31+
# Enable extensions
32+
azd config set alpha.extensions.enabled on
33+
34+
# Add azd app extension source
35+
azd extension source add app https://raw.githubusercontent.com/jongio/azd-app/main/registry.json
36+
37+
# Install the extension
38+
azd extension install app
39+
```
440

541
## Quick Start
642

743
```bash
844
# Install dependencies
9-
azd-app deps
45+
azd app deps
1046

1147
# Start the API service
12-
azd-app run
48+
azd app run
1349
```
1450

51+
The dashboard will open automatically at `http://localhost:5050`.
52+
1553
## Demonstrating AI Debugging
1654

17-
This project includes an **intentional bug** for demonstrating AI debugging capabilities:
55+
This project includes an **intentional bug** for demonstrating AI debugging capabilities.
1856

1957
### The Bug
2058

@@ -34,9 +72,9 @@ curl -X POST http://localhost:3000/items \
3472

3573
### Using Copilot to Debug
3674

37-
1. Run the service with `azd-app run`
75+
1. Run the service with `azd app run`
3876
2. Trigger the bug with the curl command above
39-
3. Open GitHub Copilot and ask:
77+
3. Open GitHub Copilot Chat (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> on Windows/Linux or <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> on macOS) and ask:
4078

4179
> "Check the API logs for errors"
4280
@@ -56,31 +94,46 @@ curl -X POST http://localhost:3000/items \
5694

5795
## MCP Configuration
5896

59-
The `.vscode/mcp.json` file configures the azd-app MCP server for Copilot:
97+
The `.vscode/mcp.json` file configures the azd app MCP server for Copilot:
6098

6199
```json
62100
{
63101
"servers": {
64-
"azd-app": {
65-
"type": "stdio",
66-
"command": "azd-app",
67-
"args": ["mcp"]
102+
"Azure Developer CLI - App Extension": {
103+
"command": "azd",
104+
"args": ["app", "mcp", "serve"]
68105
}
69106
}
70107
}
71108
```
72109

73110
## Available MCP Tools
74111

75-
When debugging with Copilot, these tools are available:
112+
When debugging with Copilot, 10 tools are available across three categories:
76113

114+
### Observe
77115
| Tool | Description |
78116
|------|-------------|
79-
| `get_services` | List all services and their status |
80-
| `get_service_logs` | Fetch logs from a running service |
81-
| `restart_service` | Restart a service after code changes |
117+
| `get_services` | List all services with status, ports, and health |
118+
| `get_service_logs` | Fetch logs with optional filtering by level and time |
82119
| `get_project_info` | Get azure.yaml configuration |
83-
| `get_environment_variables` | Check environment variables |
120+
121+
### Operate
122+
| Tool | Description |
123+
|------|-------------|
124+
| `run_services` | Start all or specific services |
125+
| `stop_services` | Stop all or specific services |
126+
| `restart_service` | Restart a specific service |
127+
| `install_dependencies` | Install dependencies for services |
128+
129+
### Configure
130+
| Tool | Description |
131+
|------|-------------|
132+
| `check_requirements` | Verify prerequisites (Node.js, Python, etc.) |
133+
| `get_environment_variables` | Get environment variables (sensitive values redacted) |
134+
| `set_environment_variable` | Set an environment variable for a service |
135+
136+
See the full [MCP Tools Reference](https://jongio.github.io/azd-app/mcp/tools/) for detailed documentation.
84137

85138
## Project Structure
86139

@@ -106,6 +159,9 @@ demo/
106159

107160
## Learn More
108161

109-
- [azd-app Documentation](https://jongio.github.io/azd-app/)
110-
- [MCP Integration Guide](https://jongio.github.io/azd-app/mcp/)
111-
- [AI Debugging Tips](https://jongio.github.io/azd-app/examples/)
162+
- [azd app Documentation](https://jongio.github.io/azd-app/)
163+
- [Quick Start Guide](https://jongio.github.io/azd-app/quick-start/)
164+
- [Guided Tour](https://jongio.github.io/azd-app/tour/)
165+
- [MCP Server & AI Debugging](https://jongio.github.io/azd-app/mcp/)
166+
- [MCP Tools Reference](https://jongio.github.io/azd-app/mcp/tools/)
167+
- [CLI Reference](https://jongio.github.io/azd-app/reference/cli/)

0 commit comments

Comments
 (0)