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

Commit 60e16b4

Browse files
authored
Enhance best practices tools descriptions (#1029)
1 parent b222a7d commit 60e16b4

File tree

5 files changed

+20
-8
lines changed

5 files changed

+20
-8
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ The Azure MCP Server updates automatically by default whenever a new release com
3737
- Fixed KQL string escaping in Workbooks service queries.
3838
- Standardized Azure Storage command descriptions, option names, and parameter names for consistency across all storage commands. Updated JSON serialization context to remove unused model types and improve organization. [[#1015](https://github.com/Azure/azure-mcp/pull/1015)]
3939
- Update to .NET 10 SDK to prepare for .NET tool packing.
40+
- Enhance `bestpractices` and `azureterraformbestpractices` tool descriptions to better work with the vscode copilot tool grouping feature. [[#1029](https://github.com/Azure/azure-mcp/pull/1029)]
4041

4142
## 0.5.7 (2025-08-19)
4243

‎areas/azurebestpractices/src/AzureMcp.AzureBestPractices/AzureBestPracticesSetup.cs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ public void RegisterCommands(CommandGroup rootGroup, ILoggerFactory loggerFactor
2020
// Register Azure Best Practices command at the root level
2121
var bestPractices = new CommandGroup(
2222
"bestpractices",
23-
"Returns secure, production-grade Azure best practices. Call this before generating Azure SDK code."
23+
@"Azure best practices - Commands return a list of best practices for code generation, operations and deployment
24+
when working with Azure services. It should be called for any code generation, deployment or
25+
operations involving Azure, Azure Functions, Azure Kubernetes Service (AKS), Azure Container
26+
Apps (ACA), Bicep, Terraform, Azure Cache, Redis, CosmosDB, Entra, Azure Active Directory,
27+
Azure App Services, or any other Azure technology or programming language. Only call this function
28+
when you are confident the user is discussing Azure. If this tool needs to be categorized,
29+
it belongs to the Azure Best Practices category."
2430
);
2531
rootGroup.AddSubGroup(bestPractices);
2632

‎areas/azurebestpractices/src/AzureMcp.AzureBestPractices/Commands/BestPracticesCommand.cs‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,13 @@ public sealed class BestPracticesCommand(ILogger<BestPracticesCommand> logger) :
2222
public override string Name => "get";
2323

2424
public override string Description =>
25-
"Returns best practices for secure, production-grade Azure usage. " +
26-
"Call this command and follow its guidance before generating or suggesting any Azure code. " +
27-
"This command returns the content of the best practices file as a string array.";
25+
@"This tool returns a list of best practices for code generation, operations and deployment
26+
when working with Azure services. It should be called for any code generation, deployment or
27+
operations involving Azure, Azure Functions, Azure Kubernetes Service (AKS), Azure Container
28+
Apps (ACA), Bicep, Terraform, Azure Cache, Redis, CosmosDB, Entra, Azure Active Directory,
29+
Azure App Services, or any other Azure technology or programming language. Only call this function
30+
when you are confident the user is discussing Azure. If this tool needs to be categorized,
31+
it belongs to the Azure Best Practices category.";
2832

2933
public override string Title => CommandTitle;
3034

‎areas/azureterraformbestpractices/src/AzureMcp.AzureTerraformBestPractices/AzureTerraformBestPracticesSetup.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ public void RegisterCommands(CommandGroup rootGroup, ILoggerFactory loggerFactor
2020
// Register Azure Terraform Best Practices command at the root level
2121
var azureTerraformBestPractices = new CommandGroup(
2222
"azureterraformbestpractices",
23-
"Returns Terraform best practices for Azure. Call this before generating Terraform code for Azure Providers."
23+
@"Returns Terraform best practices for Azure. Call this before generating Terraform code for Azure Providers.
24+
If this tool needs to be categorized, it belongs to the Azure Best Practices category."
2425
);
2526
rootGroup.AddSubGroup(azureTerraformBestPractices);
2627
azureTerraformBestPractices.AddCommand(

‎areas/azureterraformbestpractices/src/AzureMcp.AzureTerraformBestPractices/Commands/AzureTerraformBestPracticesGetCommand.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ private static string LoadBestPracticesText()
2626
public override string Name => "get";
2727

2828
public override string Description =>
29-
"Returns Terraform best practices for Azure. " +
30-
"Call this command and follow its guidance before generating or suggesting any Terraform code specific to Azure. " +
31-
"This command returns the content of the markdown file as a string array.";
29+
@"Returns Terraform best practices for Azure. Call this command and follow its guidance before
30+
generating or suggesting any Terraform code specific to Azure. If this tool needs to be categorized, it belongs to
31+
the Azure Best Practices category.";
3232

3333
public override string Title => CommandTitle;
3434

0 commit comments

Comments
 (0)