使用说明

项目简介

'unblu-docs-explorer' 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在帮助用户探索和查询 Unblu 产品的官方文档。它通过 MCP 协议与客户端通信,提供资源(文档章节)和工具(文档搜索),使得 LLM 应用可以方便地访问和利用 Unblu 文档内容。

主要功能点

  • 资源管理: 托管 Unblu 文档的不同章节作为资源,客户端可以获取文档章节的元数据和内容。
  • 文档搜索工具: 提供 'search_docs' 工具,允许客户端根据关键词搜索 Unblu 文档内容,并返回相关文档章节的路径和相关性得分。
  • MCP 协议支持: 完全实现了 MCP 协议,可以通过 JSON-RPC 与客户端进行通信。
  • 标准输入/输出 (Stdio) 传输: 使用标准输入/输出作为默认的 MCP 传输协议,易于集成和部署。

安装步骤

  1. 克隆仓库: 从 GitHub 克隆 'unblu-docs-explorer' 仓库到本地。
    git clone https://github.com/ichoosetoaccept/unblu-docs-explorer.git
    cd unblu-docs-explorer
  2. 安装依赖: 使用 pip 安装项目依赖。
    pip install -e .

服务器配置

MCP 客户端需要配置以下信息以连接到 'unblu-docs-explorer' 服务器。以下是 JSON 格式的配置信息,可以直接复制到 MCP 客户端的配置文件中。

{
  "serverName": "unblu-docs-explorer",
  "command": "unblu-docs-explorer",
  "args": []
}

配置参数说明:

  • 'serverName': 服务器名称,可以自定义,用于在客户端标识该服务器。
  • 'command': 启动服务器的命令。这里设置为 'unblu-docs-explorer',前提是安装步骤中的 'pip install -e .' 已将 'unblu-docs-explorer' 命令添加到系统路径。
  • 'args': 启动命令的参数。这里为空列表,表示不传递任何参数。服务器默认会加载 'config.json' 配置文件。

基本使用方法

  1. 启动服务器: 在终端中运行以下命令启动 'unblu-docs-explorer' MCP 服务器。
    unblu-docs-explorer
    服务器启动后,会监听标准输入,等待 MCP 客户端的请求。
  2. 配置 MCP 客户端: 在 MCP 客户端中,添加上面提供的服务器配置信息。
  3. 使用 MCP 客户端: 客户端连接到服务器后,可以:
    • 列出可用资源 (文档章节)。
    • 调用 'search_docs' 工具,使用关键词搜索 Unblu 文档。
    • 获取指定资源的详细内容。

信息

分类

生产力应用