使用说明

• 项目简介

  • Sekiban MCP服务器是一个服务器端实现，围绕MCP协议提供对文档资源、工具调用和提示模板等能力的标准化访问。它通过HTTP/SSE等传输，向LLM客户端暴露文档查询、文档分段获取、全文检索等能力，并支持通过Azure OpenAI等服务实现问答型交互。

• 主要功能点

  • 文档服务：获取全部文档信息、按文件名获取文档、按章节获取内容、文档搜索、代码示例提取等。
  • 交互工具：提供对Sekiban文档的查询、导航、章节内容检索等API，便于LLM通过工具访问知识库。
  • 相关集成：若配置Azure OpenAI，可通过AskQuestion等工具让LLM直接得到基于文档上下文的回答。
  • 传输协议与接口：通过HTTP传输，支持MCP客户端以JSON-RPC风格向服务发出请求，获取响应。
  • 容错与扩展性：服务结构清晰，便于扩展更多文档源、搜索能力和更多工具。

• 安装步骤

  • 环境准备：需要安装.NET运行时与工具链（用于运行C#项目）。
  • 构建与运行
    • 打开终端，进入项目所在目录（包含Program.cs的MCP服务实现目录），执行构建或直接运行。
    • 启动后，MCP服务器将开启一个可通过HTTP传输访问的接口（默认端口若未修改通常为5000或者按配置指定的端口）。
  • 运行示例
    • 启动后，服务将监听客户端请求，客户端可通过JSON-RPC格式向服务器请求文档列表、文档内容、文档分段等数据，以及通过工具进行高级查询与交互。

• 服务器配置

  • 配置用于MCP客户端连接的JSON信息（不属于代码，仅用于说明，客户端无需读取）：
  • 示例配置（JSON文本描述，不是代码块）：
    • serverName: "SekibanDocumentMcpServer"
    • command: "dotnet"
    • args: ["Sekiban.DocumentMcpSse.dll", "--urls", "http://0.0.0.0:5000"]
  • 注释说明：
    • serverName: MCP服务器的名称，便于在客户端配置中识别。
    • command: 运行服务器的命令，常用为dotnet。
    • args: 运行服务器的参数，通常包含要执行的程序集名称以及监听地址/端口等设置。
  • 备注：实际使用时JSON内容可能因部署环境而异，请以运行时实际端口与程序集名为准；客户端仅需要知道服务器的地址即可发起请求。

• 基本使用方法

  • 启动服务器后，ML/LLM客户端可以通过MCP的JSON-RPC风格请求访问以下能力：
    • 获取文档信息与列表（用于了解文档结构、导航与章节分布）。
    • 获取特定文档内容、章节内容及相关元数据。
    • 进行关键词搜索，获取匹配结果及相关段落。
    • 调用工具（如AskQuestion）获取基于文档上下文的问答答案（如已配置Azure OpenAI）。
  • 使用示例步骤（简要）：
    • 启动MCP服务器，将提供的端点地址作为客户端的目标服务器。
    • 使用客户端发送JSON-RPC请求请求服务能力、获取文档或执行搜索等操作。
    • 如需在LLM里直接查询，调用相应的工具接口（例如文档导航、问题回答等），服务器将返回结构化的JSON响应供LLM解析使用。
  • 运行与运维要点：
    • 确保服务器在可访问的地址与端口上暴露。
    • 根据需要开启Azure OpenAI等外部服务的配置，以提供问答能力。
    • 若需要持续更新文档，请确保文档源（如docs目录）可访问，或扩展文档读取实现以覆盖更多来源。