MCP Server

此 README 是使用 C# MCP 服务器项目模板创建的。 它演示了如何使用 C# 轻松创建 MCP 服务器并将其发布为 NuGet 包。

MCP 服务器构建为自包含应用程序，不需要在目标机器上安装 .NET 运行时。 但是，由于它是自包含的，必须为每个目标平台单独构建。 默认情况下，模板配置为构建以下平台：

• win-x64
• win-arm64
• osx-arm64
• linux-x64
• linux-arm64
• linux-musl-x64

如果您的用户需要支持更多平台，请更新项目 <RuntimeIdentifiers /> 元素中的运行时标识符列表。

完整指南请参阅 aka.ms/nuget/mcp/guide。

请注意，此模板目前处于早期预览阶段。如果您有反馈，请填写简短调查。

发布到 NuGet.org 前的检查清单

• 使用下面的步骤在本地测试 MCP 服务器。
• 更新 .csproj 文件中的包元数据，特别是 <PackageId>。
• 更新 .mcp/server.json 以声明您的 MCP 服务器的输入。
  • 更多详细信息请参阅配置输入。
• 使用 dotnet pack 打包项目。

bin/Release 目录将包含包文件 (.nupkg)，可以发布到 NuGet.org。

本地开发

要在不使用已构建的 MCP 服务器包的情况下从源代码（本地）测试此 MCP 服务器，您可以配置 IDE 使用 dotnet run 直接运行项目。

{
  "servers": {
    "YuQueMCP": {
      "type": "stdio",
      "command": "dotnet",
      "args": [
        "run",
        "--project",
        "<PATH TO PROJECT DIRECTORY>"
      ]
    }
  }
}

工具文档

YuQue MCP 服务器提供了完整的语雀知识库操作功能，包括文档的创建、读取、更新、删除、搜索以及知识库结构管理等。

📖 详细工具调用文档：请参阅 语雀MCP工具调用文档.md

该文档包含：

• 8 个可用工具的详细说明和使用示例
• 环境变量配置指南
• 工具参数说明和注意事项
• 常见问题解答
• 典型工作流程示例

快速开始

配置环境变量后，您可以在支持 MCP 的 AI 助手中使用以下工具：

• get_repository_toc_tree - 获取知识库目录树
• get_document - 读取文档内容
• create_document - 创建新文档
• update_document - 更新文档内容
• delete_document - 删除文档
• move_document - 移动文档
• search - 搜索知识库内容
• get_default_repository - 获取知识库信息

测试 MCP 服务器

配置完成后，您可以向 Copilot Chat 请求操作语雀知识库，例如 请获取知识库的目录树 或 请读取文档 "getting-started"。AI 助手会使用 YuQueMCP MCP 服务器上的相应工具并显示结果。

发布到 NuGet.org

1. 运行 dotnet pack -c Release 创建 NuGet 包
2. 使用 dotnet nuget push bin/Release/*.nupkg --api-key <your-api-key> --source https://api.nuget.org/v3/index.json 发布到 NuGet.org

从 NuGet.org 使用 MCP 服务器

MCP 服务器包发布到 NuGet.org 后，您可以在首选的 IDE 中配置它。VS Code 和 Visual Studio 都使用 dnx 命令从 NuGet.org 下载并安装 MCP 服务器包。

• VS Code: 创建 <WORKSPACE DIRECTORY>/.vscode/mcp.json 文件
• Visual Studio: 创建 <SOLUTION DIRECTORY>\.mcp.json 文件

对于 VS Code 和 Visual Studio，配置文件使用以下服务器定义：

{
  "servers": {
    "YuQueMCP": {
      "type": "stdio",
      "command": "dnx",
      "args": [
        "<your package ID here>",
        "--version",
        "<your package version here>",
        "--yes"
      ]
    }
  }
}

更多信息

.NET MCP 服务器使用 ModelContextProtocol C# SDK。有关 MCP 的更多信息：

• 官方文档
• 协议规范
• GitHub 组织

有关配置和使用 MCP 服务器的更多信息，请参阅 VS Code 或 Visual Studio 文档：

• 在 VS Code 中使用 MCP 服务器（预览）
• 在 Visual Studio 中使用 MCP 服务器（预览）