关键词

QQ机器人LLM上下文服务工具扩展Prompt模板智能助手

使用说明

项目简介

AIVK-QQ 是一个基于 AIVK 生态系统构建的智能 QQ 机器人框架，核心功能是集成 MCP 服务器，旨在为大语言模型 (LLM) 应用提供标准化的上下文服务和功能扩展能力。它不仅可以作为 LLM 的后端，提供资源管理、工具调用和 Prompt 模板渲染等 MCP 核心功能，还集成了 QQ 机器人能力，方便用户快速搭建智能交互应用。此外，AIVK-QQ 提供了便捷的 命令行工具 (CLI) 和 Napcat.Shell 启动器，简化了配置、部署和管理流程。

主要功能点

  • MCP 服务器集成: 内置符合 Model Context Protocol (MCP) 标准的服务器，支持资源管理、工具注册和 Prompt 模板定义，为 LLM 客户端提供结构化的上下文信息和功能调用接口。
  • QQ 机器人框架: 基于 Napcat.Shell 实现 QQ 机器人功能，可以接收和处理 QQ 消息，并结合 MCP 服务器能力进行智能回复和交互。
  • 便捷 CLI 工具: 提供 'aivk-qq' 命令行工具，用于快速配置和管理 AIVK-QQ 项目，包括初始化配置、启动 MCP 服务器、更新 Napcat.Shell 等。
  • Napcat.Shell 启动器: 集成 Napcat.Shell 启动功能，方便用户一键启动和管理 QQ 客户端，实现 QQ 机器人功能增强。
  • 多种传输协议支持: MCP 服务器支持 'stdio' 和 'sse' 两种传输协议，满足不同场景下的连接需求。

安装步骤

  1. 安装 uv 包管理器 (如果尚未安装): 
    uv pip install uv
  2. 安装 AIVK-QQ 及其依赖: 
    uv pip install aivk_qq
    或使用 'requirements.txt' 文件安装： 
    uv pip install -r requirements.txt

服务器配置 (MCP Server for MCP Client)

MCP 客户端需要配置 MCP 服务器的启动信息才能连接并使用 AIVK-QQ 提供的服务。以下是针对不同传输模式的 MCP 服务器配置示例 (JSON 格式)：

1. stdio 传输模式 (默认)

{
  "serverName": "aivk-qq-mcp-stdio",
  "command": "aivk-qq mcp",
  "args": [],
  "description": "启动 AIVK-QQ MCP 服务器 (stdio 传输模式)",
  "transport": "stdio"
}
  • 'serverName': MCP 服务器的名称，可自定义，用于在 MCP 客户端中标识不同的服务器配置。
  • 'command': 启动 AIVK-QQ MCP 服务器的命令。默认 'stdio' 模式下，直接使用 'aivk-qq mcp' 即可。
  • 'args': 启动命令的参数列表。 'stdio' 模式无需额外参数，保持为空列表 '[]'。
  • 'description': 对该服务器配置的简要描述，方便用户理解其用途。
  • 'transport': 指定 MCP 服务器使用的传输协议，这里设置为 'stdio'。

2. SSE 传输模式

{
  "serverName": "aivk-qq-mcp-sse",
  "command": "aivk-qq mcp",
  "args": ["--transport", "sse", "--port", "10143", "--host", "127.0.0.1"],
  "description": "启动 AIVK-QQ MCP 服务器 (SSE 传输模式)",
  "transport": "sse"
}
  • 'serverName', 'description', 'transport': 与 'stdio' 模式配置相同。
  • 'command': 启动命令保持不变 'aivk-qq mcp'。
  • 'args': 启动命令的参数列表，用于配置 SSE 传输模式。
    • '--transport sse': 指定使用 SSE 传输协议。
    • '--port 10143': 指定 SSE 服务器监听的端口号，默认为 '10141'，这里设置为 '10143' 作为示例。
    • '--host 127.0.0.1': 指定 SSE 服务器监听的主机地址，默认为 'localhost'，这里设置为 '127.0.0.1' 作为示例。

注意: 请根据实际需求和网络环境配置 '--port' 和 '--host' 参数。MCP 客户端需要根据这里配置的端口和主机地址连接到 SSE 服务器。

基本使用方法

  1. 初始化 AIVK-QQ: 首次使用需要初始化 AIVK-QQ 环境并配置基本信息（如 QQ 机器人账号、管理员账号、AIVK 根目录等）。可以通过以下命令进行初始化配置：

    aivk-qq init

    或在初始化时指定 AIVK 根目录：

    aivk-qq init --path /path/to/aivk/root/

    根据提示完成配置。

  2. 启动 MCP 服务器: 使用 'aivk-qq mcp' 命令启动默认 'stdio' 模式的 MCP 服务器。

    aivk-qq mcp

    或使用以下命令启动 SSE 模式的 MCP 服务器，并指定端口和主机地址：

    aivk-qq mcp --transport sse --port 10143 --host 127.0.0.1

    启动后，MCP 服务器将在后台运行，等待 MCP 客户端连接。

  3. 配置和使用 MCP 客户端: 在 MCP 客户端中，根据您启动的 MCP 服务器模式 (stdio 或 SSE)，配置相应的服务器连接信息 (如上面提供的 JSON 配置示例)，即可连接到 AIVK-QQ MCP 服务器，并开始使用其提供的资源、工具和 Prompt 模板等功能。

  4. 使用 Napcat.Shell (可选): 如果需要使用 QQ 机器人功能，可以使用 'aivk-qq nc' 命令启动 Napcat.Shell，实现 QQ 客户端的增强功能。

    aivk-qq nc

    您还可以指定 shell 类型，例如使用 pwsh (PowerShell 7):

    aivk-qq nc --shell pwsh

更多详细配置和使用方法，请参考项目 'README.md' 文件和命令行帮助信息 ('aivk-qq help')。

信息

分类

AI与计算

访问项目