microsoft / microsoft/mcp

Write a design document covering CommandMetadata as a whole

Open
#3,543 1 comment 0 reactions 1 assignee Claimed by @alzimmermsft View on GitHub
documentation engineering item 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

`docs/design/operation-plane-metadata.md` documents a single `CommandMetadata` field without explaining the model that field belongs to. There is no document covering `CommandMetadata` as a whole.

A broader design document should cover:

- Every value on `CommandMetadataAttribute` and what each one means.
- Which values map to MCP tool annotations and which are CLI-output only.
- How a tool author chooses values, and which combinations are contradictory (for example `ReadOnly = true` with `Destructive = true`).
- How the metadata is serialized and its compatibility guarantees.

`docs/design/operation-plane-metadata.md` should be folded into it and superseded.

Raised by @alzimmermsft in review of microsoft/mcp#3368.

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.