使用说明(Markdown 要点)

  • 项目简介

    • Yanger 是一个面向 AI 客户端的后端服务器实现,按照模型上下文协议(MCP)的思路暴露多种资源与工具,以支持 LLM 客户端在对话中获取数据、执行外部功能、以及获取或注册提示/模板等能力。
    • 服务端核心职责包括:托管和管理资源与虚拟资源、注册并执行工具、以及提供可扩展的对话能力接口,通过 JSON-RPC/标准化协议与客户端通信。
  • 主要功能点(简明易懂)

    • 资源与虚拟资源管理:管理真实的播放列表、视频资源,以及通过 Takeout 等方式导入的虚拟资源,支持查询、创建、删除、更新等操作。
    • 工具注册与执行:提供一组面向 AI 客户端的工具,例如列出播放列表、获取详情、添加/删除/移动视频、搜索、获取字幕等,工具之间遵循统一的输入输出格式,方便 LLM 进行调用。
    • 转换与导出:对外部调用获得的数据进行格式化、导出和统计,方便后续分析和备份。
    • 客户端接入配置:内置 MCP 服务器对接能力,能被 Claude 等 MCP 兼容的工具链调用,支持通过标准的请求/响应模式完成操作。
    • 安全性与会话管理:在服务器端处理会话、能力声明,以及对连接进行基本的认证与状态管理(与具体实现库绑定)。
  • 安装步骤

    • 安装依赖并进入项目环境(推荐使用虚拟环境)。
    • 安装并部署:pip 安装并以可执行入口启动 MCP 服务端。
    • 启动 MCP 服务:执行适用于你的环境的命令,例如通过 Python 包提供的入口命令启动 MCP 服务端。
    • 客户端接入配置:将 MCP 客户端指向本服务器,按下面的配置示例进行设置(客户端配置请在客户端环境完成,这里仅提供服务器端信息)。
  • 服务器配置(MCP 客户端需配置服务器连接,以下为示例 JSON,展示 server 名称、启动命令与参数) { "mcpServers": { "yanger": { "server_name": "yanger", "command": "yanger", "args": ["mcp"] } } } 说明:

    • server_name:服务器标识名称,客户端将以此名称引用对应的 MCP 服务器。
    • command:启动服务器的命令名称(在本仓库中对外提供的入口点,可通过安装后的可执行命令使用)。
    • args:启动命令的参数,在此场景中通常为 ["mcp"],表示以 MCP 模式启动服务端。 注:MCP 客户端不需要在此处实现调用逻辑,仅需提供服务器的启动信息与入口命令,实际交互由 MCP 协议规范和库提供的工具处理。
  • 基本使用方法

    • 启动后端:通过相应的入口命令启动 MCP 服务器,让客户端(如 Claude 等)能够通过 MCP 接口调用暴露的工具。
    • 客户端调用方式:客户端通过 JSON-RPC 的请求对服务器发起操作,如读取资源、执行工具、获取或渲染 Prompt 等,服务器返回 JSON-RPC 风格的响应。
    • 会话与能力声明:服务器在启动时声明自身能力,客户端在对话中可以动态查询或调用相应的工具。
    • 安全与扩展:服务端设计为可扩展,便于接入新的资源、工具与分析能力,同时保留对会话与权限的基本控制。
  • 注意事项

    • MCP 的具体实现细节依赖于底层 MCP 库的版本与运行环境,请确保环境中已正确安装所需依赖。
    • 若需要与 Claude 等外部工具对接,参照仓库中给出的示例配置与工具清单进行对接与测试。

信息

分类

AI与计算