使用说明

项目简介

NeoDB MCP服务器是一个基于 Model Context Protocol (MCP) 的后端服务,它为大型语言模型(LLM)客户端提供访问 NeoDB 社交图书目录服务的桥梁。通过此服务器,LLM 可以调用预设的工具来获取 NeoDB 平台上的用户信息和图书数据,从而增强 LLM 在图书信息检索和相关应用场景中的能力。

主要功能点

  • 获取用户信息: 允许 LLM 获取当前 NeoDB 用户的基本信息,例如用户名、显示名称、邮箱等。
  • 搜索图书: 支持 LLM 根据关键词在 NeoDB 书籍目录中进行搜索,并返回相关的图书列表,包含书名、作者、评分和简介等信息。
  • 获取图书详情: 允许 LLM 通过图书 ID 获取特定图书的详细信息,包括书名、作者、评分和简介等。

安装步骤

  1. 安装 UV 包管理器: UV 是一个快速的 Python 包安装和虚拟环境管理工具,首先需要安装它。打开终端并执行以下命令:

    curl -LsSf https://astral.sh/uv/install.sh | sh

    按照提示完成 UV 的安装。

  2. 创建虚拟环境: 使用 UV 创建并激活一个 Python 虚拟环境,以隔离项目依赖。在终端中,导航到您想要存放项目的目录,并执行:

    uv venv
    source .venv/bin/activate  # 在 Unix/macOS 系统上
    # 或
    .venv\Scripts\activate     # 在 Windows 系统上
  3. 安装依赖: 安装项目所需的 Python 库。在虚拟环境激活的状态下,导航到仓库根目录(包含 'pyproject.toml' 文件的目录),并执行:

    uv pip install .

服务器配置

为了让 MCP 客户端(例如 Claude Desktop)能够连接到 NeoDB MCP 服务器,您需要在客户端的配置文件中添加服务器的配置信息。以下是一个 'claude_desktop_config.json' 文件的配置示例,您需要根据实际情况进行修改:

{
  "mcpServers": {
    "neodb": {
      "command": "uv",
      "args": [
        "--directory",
        "<项目路径>",  //  请替换为 NeoDB MCP 服务器项目所在的**绝对路径**
        "run",
        "src/neodb/server.py", // MCP 服务器脚本的相对路径,相对于项目根目录
        "<NeoDB API Base URL>", // 请替换为 NeoDB API 的基础 URL,例如 "https://neodb.social"
        "<NeoDB Access Token>"  // 请替换为您在 NeoDB 平台获取的访问令牌 (Access Token)
      ]
    }
  }
}

配置参数说明:

  • '"server name"': 服务器名称,这里是 '"neodb"',可以自定义,用于在客户端中标识该服务器。
  • '"command"': 启动服务器的命令,这里使用 'uv' 命令来运行 Python 脚本。
  • '"args"': 传递给启动命令的参数列表,包括:
    • '"--directory"': 指定项目根目录,请务必替换为 NeoDB MCP 服务器项目在您本地文件系统中的绝对路径
    • '"run"': 'uv run' 命令用于运行 Python 脚本。
    • '"src/neodb/server.py"': 指定要运行的 MCP 服务器脚本的路径,这里假设脚本位于项目根目录下的 'src/neodb/server.py'。
    • '"<NeoDB API Base URL>"': 请替换为 NeoDB API 的基础 URL,通常为 '"https://neodb.social"'。
    • '"<NeoDB Access Token>"': 请替换为您在 NeoDB 平台获取的 API 访问令牌。 您可以参考 仓库 README 中的指引获取 Access Token。

基本使用方法

  1. 启动 MCP 服务器: 在配置好 'claude_desktop_config.json' 文件后,当 MCP 客户端(如 Claude Desktop)启动时,会根据配置文件尝试连接并启动 NeoDB MCP 服务器。

  2. 在 LLM 中使用工具: 在支持 MCP 协议的 LLM 应用中,您可以指示 LLM 使用以下工具来与 NeoDB 服务交互:

    • 'get-user-info': 获取当前 NeoDB 用户信息。
    • 'search-books': 搜索图书,需要提供 'query' 参数(搜索关键词)。
    • 'get-book': 获取图书详情,需要提供 'book_id' 参数(图书 ID)。

    例如,您可以向 LLM 客户端发送指令:“使用 'search-books' 工具搜索关于 ‘Python 编程’ 的书籍”。LLM 客户端会调用 'search-books' 工具,并将搜索结果返回给您。

注意: 请确保您已正确安装所有依赖,配置好服务器启动参数,并已获取有效的 NeoDB API 访问令牌。

信息

分类

网页与API