使用说明

项目简介

MCP Server Templates (.NET) 提供了一系列 .NET 项目模板,旨在简化 MCP 服务器的开发流程。通过这些模板,开发者可以快速搭建具备资源管理、工具注册和 Prompt 模板渲染等核心功能的 MCP 服务器,并无缝集成到 .NET 生态系统中。该模板支持构建独立模式和混合模式的 MCP 服务器,满足不同的部署需求。

主要功能点

  • 资源 (Resources) 管理: 支持托管和管理各种类型的数据资源,为 LLM 提供结构化数据访问能力。
  • 工具 (Tools) 注册与执行: 允许注册外部功能为工具,并通过 MCP 协议供 LLM 客户端调用,扩展 LLM 的能力边界。
  • Prompt 模板 (Prompts) 定义与渲染: 支持创建和管理 Prompt 模板,实现可定制的 LLM 交互模式,优化对话效果。
  • JSON-RPC 协议通信: 遵循 MCP 协议规范,使用 JSON-RPC 与客户端进行通信,确保互操作性。
  • 会话管理: 服务器端负责管理客户端会话,维护上下文状态。
  • 能力声明: 支持声明服务器提供的资源和工具等能力,方便客户端发现和使用。
  • 多种传输协议支持: 理论上支持 Stdio, SSE, WebSocket 等传输协议(具体实现需参考模板和示例)。

安装步骤

  1. 安装 .NET SDK: 确保您的开发环境已安装 .NET SDK (建议安装最新版本)。您可以从 https://dotnet.microsoft.com/download 下载并安装。
  2. 安装 MCP Server Templates: 打开命令行终端,运行以下命令安装模板:
    dotnet new install NikiforovAll.Templates.Mcp.Server

服务器配置

MCP 客户端需要配置以下信息以连接到 MCP 服务器。以下是一个通用的配置示例,假设您使用 'dotnet run' 命令启动服务器:

{
  "serverName": "MyMCPServer",
  "command": "dotnet",
  "args": [ "run", "--project", "<YourServerProjectFilePath>" ]
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,您可以自定义。
  • 'command': 启动服务器的命令,对于 .NET 应用,通常为 'dotnet'。
  • 'args': 传递给启动命令的参数列表。
    • '"run"': .NET CLI 命令,用于运行 .NET 项目。
    • '"--project", "<YourServerProjectFilePath>"': 指定服务器项目文件路径。请将 '<YourServerProjectFilePath>' 替换为实际的服务器项目文件路径(例如:'./MyMcpServer.csproj' 或相对路径)。 如果您在服务器项目目录下启动客户端,可以省略 '--project' 参数,'args' 简化为 '["run"]'。

注意: 实际的服务器启动命令和参数可能会根据您创建的项目类型和具体需求有所不同。请参考模板生成的项目文档或示例代码进行调整。

基本使用方法

  1. 创建 MCP 服务器项目: 使用已安装的模板创建新的 MCP 服务器项目。例如,创建名为 'MyMcpServer' 的独立模式服务器:
    dotnet new mcp-server -n MyMcpServer
    或创建混合模式服务器:
    dotnet new mcp-server-hybrid -n MyHybridMcpServer
  2. 编写服务器端代码: 根据您的需求,在生成的项目代码中实现资源管理、工具注册和 Prompt 模板定义等功能。具体可参考模板中的示例代码和文档。
  3. 启动 MCP 服务器: 导航到服务器项目目录 ('MyMcpServer'),运行 'dotnet run' 命令启动服务器。
  4. 配置 MCP 客户端: 在 MCP 客户端中,根据上述 “服务器配置” 部分的说明,配置连接到您的 MCP 服务器所需的信息。
  5. 客户端与服务器交互: 客户端通过 MCP 协议向服务器发送请求,例如读取资源、调用工具或获取 Prompt。服务器接收请求并返回响应。

信息

分类

开发者工具