Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Doc Gap] ADME tools disabled but still documented in azmcp-commands.md and README.md

Open Beginner friendly
  • Is something wrong?
#3,815 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
azure, csharp
Domain
documentation

Research direction

Start with the disabled AdmeSetup registration in servers/Azure.Mcp.Server/src/Program.cs, then inspect the ADME sections in servers/Azure.Mcp.Server/docs/azmcp-commands.md and servers/Azure.Mcp.Server/README.md. Remove documentation for the unavailable commands and service, while leaving e2eTestPrompts.md unchanged. Run the listed dotnet build and cspell commands to verify the documentation update.

Written by the indexing model from the issue text.

Description

copilot documentation

Documentation Gap

Server: Azure.Mcp.Server
Tool directory: tools/Azure.Mcp.Tools.Adme
Triggered by: de756df2eb3e1994f58f3a6117ab6b2baa8c264e (PR #3805) by @ayushiaks
Changed files: servers/Azure.Mcp.Server/src/Program.cs, servers/Azure.Mcp.Server/docs/azmcp-commands.md, servers/Azure.Mcp.Server/docs/e2eTestPrompts.md, servers/Azure.Mcp.Server/changelog-entries/adme-disable-ga.yaml, tools/Azure.Mcp.Tools.Adme/tests/Azure.Mcp.Tools.Adme.Tests/Azure.Mcp.Tools.Adme.Tests.csproj

What Changed

PR #3805 ("Disabling ADME tools for GA release") commented out the AdmeSetup() registration in Program.cs, disabled the ADME unit tests (HasUnitTests set to false), and removed all e2e test prompts for the "Azure Data Manager for Energy" service from e2eTestPrompts.md. This is a breaking change per the new changelog entry (Breaking Change: Removed the ADME tools temporarily for GA release.). However, the CLI command reference documentation was only partially cleaned up — the azmcp adme * command blocks remain fully documented, and the server's top-level README still advertises ADME capabilities to users as if the tools are active.

Gaps Found

  • azmcp-commands.md still documents all azmcp adme health check, azmcp adme schema get, azmcp adme schema list, azmcp adme search, azmcp adme storage record fetch/get/list, and azmcp adme storage record version list commands (only the destructive/idempotent annotation comment lines above each block were removed in the PR, not the command sections themselves). These tools are no longer registered/available, so documenting them as usable commands is misleading.
  • README.md still lists "Azure Data Manager for Energy" under the "What can you do with the Azure MCP Server?" section (with ~11 example ADME prompts) and under the "Complete List of Supported Azure Services" section, even though the ADME toolset is disabled.
  • e2eTestPrompts.md was correctly cleaned up (ADME section fully removed) — no gap there.
Files to Update
  • servers/Azure.Mcp.Server/docs/azmcp-commands.md
  • servers/Azure.Mcp.Server/README.md
Context

From Program.cs diff in the triggering commit:

-            new Azure.Mcp.Tools.Adme.AdmeSetup(),
+            // new Azure.Mcp.Tools.Adme.AdmeSetup(), - disabling for GA release

azmcp-commands.md still contains (unremoved) command blocks such as:

azmcp adme health check --endpoint <endpoint> \
                         --data-partition <data-partition> \
                         [--tenant <tenant>] \
                         [--auth-app-id <application-id-or-app-id-uri>]

README.md still contains (unremoved):

### Azure Data Manager for Energy

* "Check authentication and connectivity for my ADME endpoint and data partition"
...
- **Azure Data Manager for Energy** - Health checks and OSDU schema, record search, retrieval, and version history operations
📐 Implementation Guide

This section contains step-by-step instructions for a coding agent to implement the changes described above

Step 1: Modify files

File: servers/Azure.Mcp.Server/docs/azmcp-commands.md

  • Remove the entire "Azure Data Manager for Energy" section, including all azmcp adme health check, azmcp adme schema get, azmcp adme schema list, azmcp adme search, azmcp adme storage record fetch, azmcp adme storage record get, azmcp adme storage record list, and azmcp adme storage record version list command blocks and any surrounding prose (e.g., the cursor/query pagination notes and --auth-app-id guidance that only apply to ADME).

File: servers/Azure.Mcp.Server/README.md

  • Remove the ### Azure Data Manager for Energy subsection (with its ~11 example prompts) from the "What can you do with the Azure MCP Server?" section.
  • Remove the **Azure Data Manager for Energy** bullet from the "Complete List of Supported Azure Services" section.
  • Optionally add a brief note (or leave a changelog reference) indicating ADME support is temporarily disabled pending GA, if product wants to signal it will return.
Step 2: Verify documentation structure

Depending on the gap, verify the relevant doc file follows the expected format:

servers/Azure.Mcp.Server/docs/azmcp-commands.md — must include:

  • A global options table at the top (subscription, resource-group, tenant)
  • One ## azmcp <service> <resource> <operation> section per command, containing a description, parameters table, and example usage block

servers/Azure.Mcp.Server/README.md — must include:

  • An # Overview section describing the server
  • An # Installation section with subsections for IDE (VS Code, Visual Studio 2026, Visual Studio 2022, IntelliJ, Eclipse, Manual Setup) and Package Manager (NuGet, NPM, PyPI, Docker, MCPB)
  • A ## What can you do with the Azure MCP Server? section with per-service subsections (e.g., ### 🧮 Microsoft Foundry, ### 💾 Azure Storage, ### 🖥️ Azure Compute) showing example prompts, with no subsection for disabled services
  • A ## Complete List of Supported Azure Services section listing all supported services with emoji icons and brief descriptions, excluding disabled services
  • A # Support and Reference section with Documentation, Feedback and Support, Security, and other subsections
Step 3: Validate

Run these commands in order. Each must succeed before proceeding to the next:

  1. dotnet build servers/Azure.Mcp.Server/ — confirms the server project compiles cleanly
  2. dotnet build tools/Azure.Mcp.Tools.Adme/src/ — confirms the affected toolset still compiles (unregistered, not deleted)
  3. .\eng\common\spelling\Invoke-Cspell.ps1 — checks spelling in new or modified documentation

Next Steps

[!TIP]
Ready for automated implementation? Assign this issue to @copilot to have Copilot coding agent implement the changes described in the Implementation Guide above

Generated by Documentation Updater · copilot · auto · 51.9 AIC · ⌖ 5.49 AIC · ⊞ 11.2K · ◷

Dominant language
C#
Stars
3.7k
Forks
627
Avg merge
2d 18h
Merged PRs (30d)
190

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/mcp

All issues in microsoft/mcp

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.