microsoft / microsoft/mcp

Add additional attributes to generate MD files

Open
#2,581 1 comment 0 reactions 1 assignee Claimed by @g2vinay View on GitHub
needs-team-attention server-Azure.Mcp tools-Core
Dominant language
C#
Stars
3.7k
Forks
624
Avg merge
2d 20h
Merged PRs (30d)
220

Description

With the recent change to use an `Attribute` to define the tool command definition, we should look into adding additional `Attribute`s that can be used to automatically generated MD files that reference tools. Example MD files are

- `azmcp-commands.md`
- `e2eTestPrompts.md` (easiest addition)
- `README.md`'s "What can you do with the Azure MCP Server?" section

Right now, those sections are additional work needed to be done while creating or modifying tool commands.

Instead, we could create tooling that consumes the source of a given MCP server to generate these files in a consistent way. And it'll put adding this information in line with the tool command itself.

```dotnet
[CommandMetadata(
Id = "eb2363f1-f21f-45fc-ad63-bacfbae8c45c",
Name = "get",
Title = "Get Storage Account Details",
Description = "Retrieves detailed information about Azure Storage accounts, including account name, location, SKU, kind, hierarchical namespace status, HTTPS-only settings, and blob public access configuration. If a specific account name is not provided, the command will return details for all accounts in a subscription.",
Destructive = false,
Idempotent = true,
OpenWorld = false,
ReadOnly = true,
Secret = false,
LocalRequired = false)]
[ExamplePrompts(
"Show me the details for my storage account ",
"Get details about the storage account ",
"List all storage accounts in my subscription including their location and SKU",
"Show me my storage accounts with whether hierarchical namespace (HNS) is enabled",
"Show me the storage accounts in my subscription and include HTTPS-only and public blob access settings")]

public sealed class AccountGetCommand(ILogger logger, IStorageService storageService) : SubscriptionCommand()
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.