CrestApps.OrchardCore MCP Server

使用说明（Markdown 格式）

• 项目简介

  • 该组件属于 CrestApps.OrchardCore 的 MCP 服务端实现，设计目标是为 LLM 客户端提供标准化的上下文服务，包括资源托管与访问、工具注册与调用，以及可定制的提示模板管理与渲染。服务端通过 JSON-RPC 与客户端通信，支持会话管理和能力声明，且具备多传输协议的扩展能力。

• 主要功能点

  • 资源管理：托管与访问资源，便于 LLM 在对话中引用外部数据。
  • 工具注册与执行：注册外部工具、调用工具以扩展 LLM 能力。
  • Prompt 模板：定义、渲染并可扩展的提示模板，支援自定义的交互模式。
  • JSON-RPC 通信：服务器按 MCP 标准接收请求并返回 JSON-RPC 响应。
  • 会话与能力声明：跟踪会话并表达服务器能力，支持多传输协议（如 StdIO、SSE、WebSocket）。
  • 安全与扩展性：设计考虑安全性、模块化、可扩展的后端架构。

• 安装步骤

  • 将代码仓库克隆至本地开发环境。
  • 安装并配置所需的 .NET SDK。
  • 构建解决方案（dotnet build）。
  • 运行服务器（dotnet run），并在 Orchards Core Admin 或对应前置服务中启用 MCP 相关模块。
  • 根据需要配置客户端连接参数，以便通过 MCP 的 JSON-RPC 与服务端进行通信。

• 服务器配置（面向 MCP 客户端的配置信息描述，Json 配置形式仅为描述性说明）

  • serverName（服务器名称）：CrestApps.OrchardCore.MCP.Server
  • command（启动命令）：dotnet
  • args（启动参数）：包含要执行的应用程序集和启动参数，例如：CrestApps.OrchardCore.dll 与网络绑定参数（如 --urls http://localhost:5000）等。
  • 备注：MCP 客户端需要提供启动命令与参数来连接 MCP 服务器，实际注入的具体命令/参数应以部署环境为准，但核心思想是通过命令行启动服务并监听指定地址，客户端再通过 MCP 的 JSON-RPC 与之通信。

• 基本使用方法

  • 启动 MCP 服务端并确保其对外提供 MCP 的端点（如 HTTP/S 或 WebSocket）。
  • 配置 MCP 客户端以连接该服务器，确保服务器名称、启动命令与参数与运行环境一致。
  • 客户端通过 JSON-RPC 向服务器请求读取资源、执行工具、获取并渲染 Prompts 等能力，服务器返回标准的 JSON-RPC 响应。
  • 在运行过程中可通过 Orchards Core Admin Dashboard 或相应的管理端管理资源、工具与 Prompts 的注册与配置。