使用说明

项目简介

本项目 'AZD模板助手 MCP 服务器' 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在简化和增强 Azure Developer CLI (azd) 模板的使用体验。它提供了一系列工具，帮助开发者更有效地搜索、分析、验证和创建 azd 模板，从而加速云应用的开发和部署流程。

主要功能点

模板搜索:
- 搜索本地已安装的 azd CLI 模板。
- 搜索 Azure AI Gallery 中的模板。
- 支持关键词过滤，快速找到所需的模板。
模板列表: 列出所有可用的本地 azd CLI 模板，方便浏览和选择。
模板分析: 分析 azd 模板目录的结构和配置，提供改进建议，例如基础设施即代码、应用代码结构等。
模板验证:
- 验证 azd 模板是否符合最佳实践，包括文档完整性、基础设施配置、安全设置、开发环境配置和 GitHub 工作流配置等。
- 提供详细的验证报告，指出错误、警告和建议。
模板创建:
- 根据用户指定的语言和架构，快速创建符合最佳实践的 azd 模板骨架。
- 支持多种编程语言和应用架构。

安装步骤

全局安装 (推荐作为 CLI 工具使用) 打开终端，运行以下命令全局安装本工具：
```
npm install -g mcp-azd-template
```
本地安装 (在项目中使用) 如果要在现有项目中使用，请在项目目录下运行：
```
npm install mcp-azd-template
```

服务器配置

本 MCP 服务器主要设计用于与 VS Code MCP 客户端扩展集成。您需要在 VS Code 的 'settings.json' 文件中配置服务器信息。

配置示例 (添加到 VS Code 的 settings.json):

"mcp": {
  "servers": {
    "azd-template-helper": { // 服务器名称，可以自定义
      "command": "mcp-azd-template" // 启动服务器的命令，全局安装后可以直接使用命令名
      // 如果本地安装或需要指定 Node.js 路径，可以使用以下配置：
      // "command": "/path/to/your/node",
      // "args": ["/path/to/your/project/node_modules/mcp-azd-template/dist/cli.js"]
    }
  }
}

或者，使用 'npx' 无需安装 (添加到 VS Code 的 settings.json):

"mcp": {
  "servers": {
    "azd-template-helper": { // 服务器名称，可以自定义
      "command": "npx", // 使用 npx 命令
      "args": [
        "-y", // 自动确认安装
        "mcp-azd-template@latest" // 要执行的 npm 包，指定最新版本
      ]
    }
  }
}

配置完成后，VS Code MCP 客户端应该能够自动检测并连接到此 MCP 服务器。

基本使用方法

配置完成后，在支持 MCP 协议的 AI 客户端（如 VS Code Copilot）中，您可以使用自然语言提示词来调用 MCP 服务器提供的工具，例如：

模板搜索示例:

Search for Java Spring Boot templates in the Azure AI gallery

Find Next.js starter templates from both the AI gallery and azd CLI

模板分析示例:

Can you analyze my current Azure Developer CLI template and provide feedback?

Review this azd template in my current directory and tell me what needs improvement.

模板验证示例:

Validate this azd template against best practices.

Check if my azd template follows Microsoft's recommended structure and security practices.

模板创建示例:

Create a new Azure Function app template using TypeScript.

I need a starter template for a containerized web app using Python. Can you create one?

模板列表示例:

Show me available azd templates I can use as references.

What are the official Azure Developer CLI templates available?

故障排除示例:

My azd template is missing documentation. What specific sections should I add?

How do I fix the security warnings in my template's validation report?

通过这些提示词，AI 客户端将调用 MCP 服务器的相应工具，并返回分析、验证或搜索结果，辅助您更高效地使用和管理 azd 模板。

关键词