AntDesign.Cli

一个用于查询 Ant Design Blazor 组件信息的命令行工具和 MCP（模型上下文协议）服务器。它帮助开发者通过命令行或 GitHub Copilot 快速访问组件文档和 API 细节。

关于详细实现指南和技术讨论，请参阅我们的博客文章：

• 作为 GitHub Copilot MCP 服务器的 .NET 本地工具开发

功能

• 搜索特定组件信息
• 列出所有可用组件
• 按类别筛选组件
• 支持 CLI 和 MCP 服务器模式
• 集成 GitHub Copilot

支持的工具

CLI 命令

• list: 列出所有组件
• search -n <ComponentName1,ComponentName2,...>: 批量按名称搜索组件
• category -n <CategoryName>: 按类别筛选组件
• demo-list: 列出所有组件演示
• demo -n <ComponentName>: 查看特定组件的演示

MCP 服务器工具

• SearchComponents: 批量按名称搜索组件
• ListComponents: 列出所有组件
• GetComponentsByCategory: 按类别获取组件
• ListAllDemos: 列出所有组件演示
• SearchComponentDemos: 按组件名称和场景获取演示

安装

dotnet tool install --global AntDesign.Cli

使用方法

CLI 模式

# 列出所有组件
antblazor list

# 搜索特定组件
antblazor search -n Button

# 按类别获取组件
antblazor category -n Navigation

MCP 服务器模式（适用于 GitHub Copilot）

1. 全局安装该工具
2. 在你的 VS Code 的 mcp.json 中添加以下配置：

{
    "servers": {
        "antblazor": {
            "type": "stdio",
            "command": "antblazor",
            "args": ["-mcp"]
        }
    }
}

或者使用安装链接：

vscode:mcp/install?{"name":"antblazor","command":"antblazor","args":["-mcp"]}

实现细节

该项目展示了如何：

1. 创建一个 .NET 全局工具
2. 实现 MCP 服务器功能
3. 加载和解析组件文档
4. 提供干净的 CLI 接口
5. 启用 GitHub Copilot 集成

使用的关键技术：

• .NET 9.0
• System.CommandLine
• ModelContextProtocol
• System.Text.Json

技术细节

将 .NET CLI 工具转换为 MCP 服务器

将 .NET CLI 工具转换为 MCP 服务器涉及以下几个步骤：

1. 添加所需包

<ItemGroup>
    <PackageReference Include="ModelContextProtocol" Version="0.1.0-preview.12" />
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.0" />
</ItemGroup>

2. 创建 MCP 工具类

[McpServerToolType]
public sealed class AntDesignTools
{
    [McpServerTool]
    [Description("按名称搜索 Ant Design Blazor 组件")]
    public async Task<string> SearchComponent(
        [Description("要搜索的组件名称")] string name)
    {
        // 实现
    }
}

3. 配置 MCP 服务器

if (args.Length == 1 && args[0] == "-mcp")
{
    var builder = Host.CreateApplicationBuilder(args);
    builder.Services.AddMcpServer()
        .WithStdioServerTransport()
        .WithTools<AntDesignTools>();
    await builder.Build().RunAsync();
    return 0;
}

4. 同时处理 CLI 和 MCP 模式

• 维护现有的 CLI 功能
• 添加 MCP 服务器支持
• 共享核心业务逻辑

5. 优点

• 增强的开发者体验
• AI 助力的支持
• 与 GitHub Copilot 的无缝集成
• 提高文档的可访问性

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

MIT