Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Commit a9cc01c

Browse files
authored
Updated e2e test prompts and documentation around them (#503)
* Added e2e prompts for azd * Updated prompts * Correctly re-ordered a few commands * Added missing commands and updated a couple for Monitor logs * Update e2eTestPrompts.md * Updated instructions around e2e test prompts in CONTRIBUTING.md and this repository's PR template
1 parent 9decf3e commit a9cc01c

File tree

3 files changed

+36
-13
lines changed

3 files changed

+36
-13
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
## Checklist before merging
66
- [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-mcp/blob/main/CONTRIBUTING.md) on pull request process, code style, and testing.**
77
- [ ] Title of the pull request is clear and informative.
8-
- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).
8+
- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).
99
- [ ] For core features, I have added thorough tests.
10-
- [ ] For user-impacting changes (bug fixes, new features, UI/UX changes), I have added a CHANGELOG.md entry linking to this PR.
10+
- [ ] For user-impacting changes (bug fixes, new features, UI/UX changes), I have added a `CHANGELOG.md` entry linking to this PR.
11+
- [ ] For MCP tool additions/updates, I have updated the documentation in `README.md`, the command list in `azmcp-commands.md`, and end-to-end test prompts in `/e2eTests/e2eTestPrompts.md`.
1112
- [ ] Have a team member run [live tests](https://github.com/Azure/azure-mcp/blob/main/CONTRIBUTING.md#live-tests):
1213
- [ ] Team Member: Inspect PR for security issues before queueing a test run
1314
- [ ] Team Member: Add this comment to the pr `/azp run azure - mcp` to start the run

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ The project is organized as follows:
6565
- Reference the issue you created
6666
- Include tests in the `/tests` folder
6767
- Ensure all tests pass
68+
- Add sample prompts to `/e2eTests/e2eTestPrompts.md`
6869
- Follow the code style requirements
6970

7071
## Development Process

e2eTests/e2eTestPrompts.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ This file contains prompts used for end-to-end testing to ensure each tool is in
77
| azmcp-bestpractices-get | Fetch the latest Azure best practices |
88
| azmcp-bestpractices-get | Fetch the latest Azure best practices and generate code sample to get a secret from Azure Key Vault |
99

10+
## Bicep
11+
12+
| Tool Name | Test Prompt |
13+
|:----------|:----------|
14+
| azmcp-bicepschema-get | How can I use Bicep to create an Azure OpenAI service? |
15+
16+
## Resource Group
17+
18+
| Tool Name | Test Prompt |
19+
|:----------|:----------|
20+
| azmcp-group-list | List all resource groups in my subscription |
21+
| azmcp-group-list | Show me the resource groups in my subscription |
22+
| azmcp-group-list | Show me my resource groups |
23+
1024
## Subscription Management
1125

1226
| Tool Name | Test Prompt |
@@ -16,13 +30,12 @@ This file contains prompts used for end-to-end testing to ensure each tool is in
1630
| azmcp-subscription-list | Show me my subscriptions |
1731
| azmcp-subscription-list | What is my current subscription? |
1832

19-
## Resource Group
33+
## Tools
2034

2135
| Tool Name | Test Prompt |
2236
|:----------|:----------|
23-
| azmcp-group-list | List all resource groups in my subscription |
24-
| azmcp-group-list | Show me the resource groups in my subscription |
25-
| azmcp-group-list | Show me my resource groups |
37+
| azmcp-tool-list | List all available tools in the Azure MCP server |
38+
| azmcp-tool-list | Show me the available tools in the Azure MCP server |
2639

2740
## Azure App Configuration
2841

@@ -76,6 +89,13 @@ This file contains prompts used for end-to-end testing to ensure each tool is in
7689
| azmcp-kusto-table-list | Show me the tables in the Data Explorer database <database_name> in cluster <cluster_name> |
7790
| azmcp-kusto-table-schema | Show me the schema for table <table_name> in the Data Explorer database <database_name> in cluster <cluster_name> |
7891

92+
## Azure Developer CLI
93+
94+
| Tool Name | Test Prompt |
95+
|:----------|:----------|
96+
| azmcp-extension-azd | Create a To-Do list web application that uses NodeJS and MongoDB |
97+
| azmcp-extension-azd | Deploy my web application to Azure App Service |
98+
7999
## Azure Key Vault
80100

81101
| Tool Name | Test Prompt |
@@ -91,7 +111,6 @@ This file contains prompts used for end-to-end testing to ensure each tool is in
91111
| Tool Name | Test Prompt |
92112
|:----------|:----------|
93113
| azmcp-monitor-healthmodels-entity-gethealth | Show me the health status of entity <entity_id> in the Log Analytics workspace <workspace_name> |
94-
| azmcp-monitor-log-query | Show me the logs for the past hour in the Log Analytics workspace <workspace_name> |
95114
| azmcp-monitor-metrics-definitions | What metric definitions are available for the Application Insights resource <resource_name> |
96115
| azmcp-monitor-metrics-definitions | Show me all available metrics and their definitions for storage account <account_name> |
97116
| azmcp-monitor-metrics-definitions | Get metric definitions for <resource_type> <resource_name> from the namespace |
@@ -101,13 +120,15 @@ This file contains prompts used for end-to-end testing to ensure each tool is in
101120
| azmcp-monitor-metrics-query | Analyze the performance trends and response times for Application Insights resource <resource_name> over the last <time_period> |
102121
| azmcp-monitor-metrics-query | Check the availability metrics for my Application Insights resource <resource_name> for the last <time_period> |
103122
| azmcp-monitor-metrics-query | Get the <aggregation_type> <metric_name> metric for <resource_type> <resource_name> over the last <time_period> with intervals |
123+
| azmcp-monitor-resource-logs-query | Show me the logs for the past hour for the resource <resource_name> in the Log Analytics workspace <workspace_name> |
104124
| azmcp-monitor-table-list | List all tables in the Log Analytics workspace <workspace_name> |
105125
| azmcp-monitor-table-list | Show me the tables in the Log Analytics workspace <workspace_name> |
106126
| azmcp-monitor-table-type-list | List all available table types in the Log Analytics workspace <workspace_name> |
107127
| azmcp-monitor-table-type-list | Show me the available table types in the Log Analytics workspace <workspace_name> |
108128
| azmcp-monitor-workspace-list | List all Log Analytics workspaces in my subscription |
109129
| azmcp-monitor-workspace-list | Show me the Log Analytics workspaces in my subscription |
110130
| azmcp-monitor-workspace-list | Show me my Log Analytics workspaces |
131+
| azmcp-monitor-workspace-logs-query | Show me the logs for the past hour in the Log Analytics workspace <workspace_name> |
111132

112133
## Azure Native ISV
113134

@@ -137,16 +158,16 @@ This file contains prompts used for end-to-end testing to ensure each tool is in
137158

138159
| Tool Name | Test Prompt |
139160
|:----------|:----------|
140-
| azmcp-redis-cluster-database-list | List all databases in the Redis Cluster <cluster_name> |
141-
| azmcp-redis-cluster-database-list | Show me the databases in the Redis Cluster <cluster_name> |
142-
| azmcp-redis-cluster-list | List all Redis Clusters in my subscription |
143-
| azmcp-redis-cluster-list | Show me the Redis Clusters in my subscription |
144-
| azmcp-redis-cluster-list | Show me my Redis Clusters |
145161
| azmcp-redis-cache-list | List all Redis Caches in my subscription |
146162
| azmcp-redis-cache-list | Show me the Redis Caches in my subscription |
147163
| azmcp-redis-cache-list | Show me my Redis Caches |
148164
| azmcp-redis-cache-list-accesspolicy | List all access policies in the Redis Cache <cache_name> |
149165
| azmcp-redis-cache-list-accesspolicy | Show me the access policies in the Redis Cache <cache_name> |
166+
| azmcp-redis-cluster-database-list | List all databases in the Redis Cluster <cluster_name> |
167+
| azmcp-redis-cluster-database-list | Show me the databases in the Redis Cluster <cluster_name> |
168+
| azmcp-redis-cluster-list | List all Redis Clusters in my subscription |
169+
| azmcp-redis-cluster-list | Show me the Redis Clusters in my subscription |
170+
| azmcp-redis-cluster-list | Show me my Redis Clusters |
150171

151172
## Azure RBAC
152173

@@ -184,9 +205,9 @@ This file contains prompts used for end-to-end testing to ensure each tool is in
184205
| azmcp-storage-account-list | List all storage accounts in my subscription |
185206
| azmcp-storage-account-list | Show me the storage accounts in my subscription |
186207
| azmcp-storage-account-list | Show me my storage accounts |
208+
| azmcp-storage-blob-container-details | Show me the properties of the storage container files in the storage account <account_name> |
187209
| azmcp-storage-blob-container-list | List all blob containers in the storage account <account_name> |
188210
| azmcp-storage-blob-container-list | Show me the blob containers in the storage account <account_name> |
189-
| azmcp-storage-blob-container-details | Show me the properties of the storage container files in the storage account <account_name> |
190211
| azmcp-storage-blob-list | List all blobs in the blob container <container_name> in the storage account <account_name> |
191212
| azmcp-storage-blob-list | Show me the blobs in the blob container <container_name> in the storage account <account_name> |
192213
| azmcp-storage-table-list | List all tables in the storage account <account_name> |

0 commit comments

Comments
 (0)