NuGet文档查询工具

用于查找本地安装的NuGet包文档的工具,可作为CLI工具和MCP服务器运行。

  • by AdamTovatt
  • C#
  • 本地部署
  • 更新于
在 GitHub 查看 AdamTovatt/nuget-docs-mcp

使用说明

NugetDocsMcp

用于查找本地安装的NuGet包文档的工具。既可作为CLI工具,又可作为AI代理的MCP(模型上下文协议)服务器。

安装

dotnet tool install --global NugetDocsMcp

安装后 nd 命令将在全球范围内可用。

要更新到最新版本:

dotnet tool update --global NugetDocsMcp

要卸载,请执行以下操作:

dotnet tool uninstall --global NugetDocsMcp

要在Claude Code中将其注册为MCP工具:

claude mcp add nugetdocs -- nd --mcp

对于Cursor或其他MCP客户端,请将以下内容添加到MCP配置中:

{
  "mcpServers": {
    "nugetdocs": {
      "command": "nd",
      "args": ["--mcp"]
    }
  }
}

用法

nd readme <package> [--version <v>]                          # Get the README for a package
nd types <package> [--version <v>] [--framework <f>]         # List all types in a package
nd search <package> <query> [--version <v>] [--framework <f>] # Search docs by member name
nd help                                                       # Show help information

例子

# Read a package's README
nd readme Dapper

# List all types in a package
nd types Microsoft.Extensions.DependencyInjection.Abstractions --version 10.0.1 --framework net8.0

# Search for a method by short name
nd search Dapper Query

# Search by qualified name
nd search Dapper "SqlMapper.Query" --version 2.1.35 --framework net8.0

行为

版本和框架自动解析

如果本地只安装了一个版本的软件包,则会自动使用它。目标框架也是如此。如果存在多个选项,但未指定任何选项,则该工具会列出可用选项,以便您选择一个。

从本地NuGet缓存读取

从全局NuGet包文件夹读取的所有查找(~/.nuget/packages/).只有已还原的包可用。

XML文档

nd search 和 nd types 阅读NuGet包附带的XML文档文件。并非所有包都包含XML文档(例如Moq不包含)。

不区分大小写的匹配

包名、版本查找、README检测和搜索查询都是不区分用例的匹配。

作为MCP服务器

nd --mcp

当作为MCP服务器运行时,可以使用以下工具:

  • nd_readme(packageName, version?) -获取软件包的README文件
  • nd_types(packageName, version?, targetFramework?) -列出包中的所有类型
  • nd_search(packageName, query, version?, targetFramework?) -按成员名称搜索文档
  • nd_help() -获取帮助

发展

git clone <repository-url>
cd nuget-docs-mcp
dotnet build NugetDocsMcp.slnx
dotnet test NugetDocsMcp.slnx

在开发过程中作为MCP服务器运行:

dotnet run --project NugetDocsMcp.Cli/NugetDocsMcp.Cli.csproj -- --mcp

要打包:

dotnet pack NugetDocsMcp.Cli/NugetDocsMcp.Cli.csproj --configuration Release

许可证

MIT许可证