mirror of
https://github.com/microsoft/mcp.git
synced 2026-11-04 12:01:31 +00:00
Replace new-command.md with skills (#2709)
This commit is contained in:
1 parent
b331560d7f
commit
4f0db29302
8 files changed
+1994
-17
No files matched your search
File diff suppressed because it is too large.
Load diff
@@ -119,7 +119,7 @@ Microsoft MCP (Model Context Protocol) servers provide AI agents with structured
|
||||
- `servers/Azure.Mcp.Server/` - Main Azure MCP server implementation
|
||||
- `tools/Azure.Mcp.Tools.{Service}/` - Individual service toolsets (Storage, SQL, etc.)
|
||||
- `eng/scripts/` - Build, test, and deployment PowerShell scripts
|
||||
- `docs/new-command.md` - Implementation guide for new commands
|
||||
- `.github/skills/add-azure-mcp-tools/SKILL.md` - Implementation guide for new commands
|
||||
- `CONTRIBUTING.md` - Contribution guidelines and workflows
|
||||
|
||||
### Good examples to follow
|
||||
@@ -167,7 +167,7 @@ dotnet build
|
||||
|
||||
## API Docs and References
|
||||
- API documentation: `/servers/Azure.Mcp.Server/docs/azmcp-commands.md` - Complete command reference
|
||||
- Implementation guide: `/servers/Azure.Mcp.Server/docs/new-command.md` - Step-by-step command creation
|
||||
- Implementation guide: `/.github/skills/add-azure-mcp-tools/SKILL.md` - Step-by-step command creation
|
||||
- Test prompts: `/servers/Azure.Mcp.Server/docs/e2eTestPrompts.md` - Example prompts for testing
|
||||
- Recorded tests: `/docs/recorded-tests.md` - Guide for converting live tests to recorded (playback) tests
|
||||
- Contributing guide: `/CONTRIBUTING.md` - Development workflow and standards
|
||||
@@ -177,8 +177,8 @@ dotnet build
|
||||
- Ask clarifying questions about Azure service requirements or command patterns
|
||||
- Propose a short plan before implementing complex features
|
||||
- Reference existing commands in similar services as templates
|
||||
- Check `/docs/new-command.md` for implementation patterns
|
||||
- Use GitHub Copilot Chat with `"create [service] [resource] [operation] command using #new-command.md as a reference"`
|
||||
- Check `/.github/skills/add-azure-mcp-tools/SKILL.md` for implementation patterns
|
||||
- Use GitHub Copilot Chat with `"create [service] [resource] [operation] command using /skills/add-azure-mcp-tools as a reference"`
|
||||
|
||||
## PR Checklist
|
||||
- Format and type check: `dotnet format && dotnet build` - all green
|
||||
@@ -499,8 +499,8 @@ context.Response.Results = ResponseResult.Create(new(results), StorageJsonContex
|
||||
|
||||
### Development Process
|
||||
1. **Create issue**: "Add command: azmcp [service] [resource] [operation]"
|
||||
2. **Use Copilot for generation**: Execute in Copilot Chat: `"create [service] [resource] [operation] command using #new-command.md as a reference"`
|
||||
3. **Follow implementation guidelines** in `/docs/new-command.md`
|
||||
2. **Use Copilot for generation**: Execute in Copilot Chat: `"create [service] [resource] [operation] command using /skills as a reference"`
|
||||
3. **Follow implementation guidelines** in `/.github/skills/add-azure-mcp-tools/SKILL.md`
|
||||
4. **Create live test infrastructure** (if Azure service): Bicep template and post-deployment script
|
||||
5. **Submit one tool per pull request** for faster review cycles
|
||||
|
||||
@@ -748,4 +748,4 @@ The server includes comprehensive telemetry integration with proper tag propagat
|
||||
|
||||
---
|
||||
|
||||
This documentation provides AI agents with comprehensive guidance for working effectively with the Microsoft MCP codebase. For additional details, see `/docs/new-command.md` for implementation specifics and `CONTRIBUTING.md` for contribution workflows.
|
||||
This documentation provides AI agents with comprehensive guidance for working effectively with the Microsoft MCP codebase. For additional details, see `/.github/skills/add-azure-mcp-tools/SKILL.md` for implementation specifics and `CONTRIBUTING.md` for contribution workflows.
|
||||
+3
-3
@@ -162,10 +162,10 @@ Do not assume the Pull Request pipeline will always ingest a missing package aut
|
||||
|
||||
```txt
|
||||
Execute in Copilot Chat:
|
||||
"create [namespace] [resource] [operation] command using #new-command.md as a reference"
|
||||
"create [namespace] [resource] [operation] command using /skills/add-azure-mcp-tools as a reference"
|
||||
```
|
||||
|
||||
4. **Follow implementation guidelines** in [docs/new-command.md](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/docs/new-command.md)
|
||||
4. **Follow implementation guidelines** in [.github/skills/add-azure-mcp-tools/SKILL.md](https://github.com/microsoft/mcp/blob/main/.github/skills/add-azure-mcp-tools/SKILL.md)
|
||||
|
||||
5. **Update documentation**:
|
||||
- Add the new command to [/servers/Azure.Mcp.Server/docs/azmcp-commands.md](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/docs/azmcp-commands.md)
|
||||
@@ -887,7 +887,7 @@ We're building this in the open. Your feedback is much appreciated, and will he
|
||||
### Additional Resources
|
||||
|
||||
- [Azure MCP Documentation](https://github.com/microsoft/mcp/blob/main/README.md)
|
||||
- [Command Implementation Guide](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/docs/new-command.md)
|
||||
- [Command Implementation Guide](https://github.com/microsoft/mcp/blob/main/.github/skills/add-azure-mcp-tools/SKILL.md)
|
||||
- [VS Code Insiders Download](https://code.visualstudio.com/insiders/)
|
||||
- [GitHub Copilot Documentation](https://docs.github.com/en/copilot)
|
||||
|
||||
|
||||
@@ -66,7 +66,7 @@ Implemented:
|
||||
|
||||
Pending / Follow‑ups (if desired):
|
||||
* Ensure every remaining command uses `UseResourceGroup()` / `RequireResourceGroup()` instead of direct `command.Options.Add(_resourceGroupOption)`.
|
||||
* Update `docs/new-command.md` to reference helpers (remove any legacy guidance).
|
||||
* Update `.github/skills/add-azure-mcp-tools/SKILL.md` to reference helpers (remove any legacy guidance).
|
||||
* Add / adjust tests:
|
||||
- Required command without RG -> 400 + standard message.
|
||||
- Optional command without RG -> succeeds (or broader listing) and does not parse-fail.
|
||||
|
||||
@@ -409,7 +409,7 @@ Add validation to your CI pipeline:
|
||||
- [x] Create compiler script: `eng/scripts/Compile-Changelog.ps1`
|
||||
- [x] Create documentation: `docs/changelog-entries`
|
||||
- [x] Update `CONTRIBUTING.md` with new changelog workflow
|
||||
- [x] Update `docs/new-command.md` to mention changelog entries for AI coding agents
|
||||
- [x] Update `.github/skills/add-azure-mcp-tools/SKILL.md` to mention changelog entries for AI coding agents
|
||||
- [x] Update `AGENTS.md` to include changelog workflow for AI agents
|
||||
- [ ] Add CI validation for YAML files (optional but recommended)
|
||||
- [x] Create sample YAML files for testing
|
||||
@@ -495,7 +495,7 @@ When using AI coding agents like GitHub Copilot to work on features, ensure they
|
||||
|
||||
### Key Documents for AI Agents
|
||||
|
||||
1. **`docs/new-command.md`** - Should include step about creating changelog entry
|
||||
1. **`.github/skills/add-azure-mcp-tools/SKILL.md`** - Should include step about creating changelog entry
|
||||
2. **`AGENTS.md`** - Should reference this changelog system
|
||||
3. **`CONTRIBUTING.md`** - Should explain when and how to create entries
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
This document defines the steps required when renaming an existing MCP tool (i.e., changing the value returned by a command's `Name` property or its parent group name). Tool names form part of the MCP protocol surface, they are how AI agents discover and invoke capabilities, so renames are **breaking changes** and must be handled carefully.
|
||||
|
||||
> **Note:** If you are adding a *new* tool rather than renaming an existing one, follow [`new-command.md`](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/docs/new-command.md) instead.
|
||||
> **Note:** If you are adding a *new* tool rather than renaming an existing one, follow [`.github/skills/add-azure-mcp-tools/SKILL.md`](https://github.com/microsoft/mcp/blob/main/.github/skills/add-azure-mcp-tools/SKILL.md) instead.
|
||||
|
||||
## What counts as a tool rename?
|
||||
|
||||
@@ -93,4 +93,4 @@ MCP clients including AI agents, IDE extensions, and automation scripts referenc
|
||||
- Users who have configured explicit tool allow-lists by name must update their configuration.
|
||||
- Recorded sessions keyed on the old name will fail playback until re-recorded.
|
||||
|
||||
For these reasons, **avoid renames unless necessary**. If the existing name is genuinely misleading or inconsistent with the naming conventions in [`new-command.md`](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/docs/new-command.md), prefer doing the rename as part of a larger breaking-change release batch rather than as a standalone PR.
|
||||
For these reasons, **avoid renames unless necessary**. If the existing name is genuinely misleading or inconsistent with the naming conventions in [`.github/skills/add-azure-mcp-tools/SKILL.md`](https://github.com/microsoft/mcp/blob/main/.github/skills/add-azure-mcp-tools/SKILL.md), prefer doing the rename as part of a larger breaking-change release batch rather than as a standalone PR.
|
||||
@@ -83,6 +83,6 @@
|
||||
<ItemGroup>
|
||||
<None Include="..\docs\azmcp-commands.md" />
|
||||
<None Include="..\docs\e2eTestPrompts.md" />
|
||||
<None Include="..\docs\new-command.md" />
|
||||
<None Include="..\..\..\.github\skills\add-azure-mcp-tools\SKILL.md" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -28,7 +28,7 @@ ensuring it passes all validation gates before PR submission.
|
||||
|
||||
### Phase 1: Implementation
|
||||
|
||||
Follow [`/servers/Azure.Mcp.Server/docs/new-command.md`](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/docs/new-command.md) as the authoritative guide.
|
||||
Follow [`/.github/skills/add-azure-mcp-tools/SKILL.md`](https://github.com/microsoft/mcp/blob/main/.github/skills/add-azure-mcp-tools/SKILL.md) as the authoritative guide.
|
||||
The Azure Backup toolset lives in `tools/Azure.Mcp.Tools.AzureBackup/`.
|
||||
|
||||
#### 1a. Create Option Definitions
|
||||
|
||||
Reference in new issue
Block a user