[CI] Add CI Gate for validating documentation matches MCP tool changes #3674

Activity

1. Connie Yau (conniey)

   self-assigned this

   on Sep 15, 2026
2. Connie Yau (conniey)

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   server-Azure.McpAzure.Mcp.ServerAzure.Mcp.Server

   Engineering ExcellenceItems required to be resolved before onboarding the "third wave" of azure RPsItems required to be resolved before onboarding the "third wave" of azure RPs

   on Sep 15, 2026
3. github-actions

   added

   needs-team-attentionWorkflow: This issue needs attention from Azure service team or MCP team.Workflow: This issue needs attention from Azure service team or MCP team.

   tools-CoreAZMCP Core functionality that all other tools build on top ofAZMCP Core functionality that all other tools build on top of

   on Sep 15, 2026
4. github-actions commented on Sep 15, 2026

   

   github-actionsbot

   on Sep 15, 2026 – with GitHub Actions

   Contributor

   More actions

   Thanks for your feedback! Connie Yau (@conniey) is looking into it.
5. Connie Yau (conniey)

   removed

   needs-team-attentionWorkflow: This issue needs attention from Azure service team or MCP team.Workflow: This issue needs attention from Azure service team or MCP team.

   on Sep 15, 2026
6. Rick Winter (RickWinter)

   added a parent issue on Sep 29, 2026

   • [EPIC] Command Contract and Documentation Drift Elimination #2496
7. Paraphern commented on Oct 11, 2026

   

   GERALD MUDDLETHWACK (Paraphern)

   on Oct 11, 2026

   More actions

   Reading this together with the closed epic #2496 - the pre-merge half is the missing piece, and the contract side of it is available off-the-shelf:

   rugsnare (open source, Apache-2.0) pins each tool's contract (name + description + inputSchema, sha-256); on a PR it diffs the live server against the pins and exits non-zero on any change - description edits, command renames and parameter changes are exactly the three classes it grades (tightened / loosened / new / notation). It ships as a ready GitHub Action that posts the was/became diff on the PR (RugSnare PR diff), so a pre-merge gate is a workflow include, not new code.

   How it maps here: pin the contracts at docs-sync time; every PR that touches a tool or its docs runs the contract diff; your doc-gap detector then validates the rendered documentation against the pinned contract of the version in the PR - pre-merge, instead of the Documentation Updater pass after it.

   We run this pattern on our own releases and publish per-version contract records for 14 public MCP servers as evidence it scales: https://github.com/Paraphern/rugsnare/tree/main/docs/servers

   Happy to sketch the workflow yaml against your doc-gap-detector flow if useful.