Skip to main content
NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-grok-bot

✨ 通过 MCP Server 与 Webhook 将聊天接入 Grok Bot ✨

license pypi python

📖 介绍

把 NoneBot2 接入 Grok Bot:

  • 发送:插件在 NoneBot 自身的 FastAPI 上挂载一个 MCP Server(Streamable HTTP),Grok Bot 通过它发送消息,支持图文混排、QQ 内置表情和本地表情包(基于 savepic)。
  • 接收:收到的消息按会话路由,POST 到对应 Grok Bot Routine 的 Webhook。

💿 安装

使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-grok-bot
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
uv
uv add nonebot-plugin-grok-bot
pip
pip install nonebot-plugin-grok-bot
pdm
pdm add nonebot-plugin-grok-bot
poetry
poetry add nonebot-plugin-grok-bot

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入

plugins = ["nonebot_plugin_grok_bot"]

如需使用本地表情包,请安装 savepic 可选依赖(例如 pip install "nonebot-plugin-grok-bot[savepic]"),并按 savepic 的说明完成配置。

⚙️ 配置

驱动器需要同时具备 ASGI 和 HTTP 客户端,例如:

DRIVER=~fastapi+~httpx+~aiohttp

Grok Bot 只能访问公网或 Tailscale 网络内的地址,HOST 需要绑定到对应网卡(例如 Tailscale IP 或 0.0.0.0)。

在 nonebot2 项目的.env文件中添加下表中的必填配置

配置项 必填 默认值 说明
GROK_BOT_MCP_PREFIX 否 /grok_bot MCP 端点为 {prefix}/mcp
GROK_BOT_MCP_TOKEN 否 无 MCP 端点的 Bearer Token,在 Grok Bot 中存为 Authorization secret;不设置则不鉴权
GROK_BOT_OWNERS 是 [] Owner 的用户 ID
GROK_BOT_ALLOWED_USERS 否 [] 除 Owner 外允许私聊的用户 ID
GROK_BOT_ALLOWED_GROUPS 否 [] 允许的群号(频道为 <guild>/<channel>)
GROK_BOT_ROUTES 是 [] 推送路由,见下文
GROK_BOT_WEBHOOK_TIMEOUT 否 10 Webhook 请求超时(秒)
GROK_BOT_WEBHOOK_RETRIES 否 3 5xx / 429 / 网络错误时的重试次数
GROK_BOT_HISTORY_SIZE 否 100 每个会话保留的最近消息数,供 get_history 查询

白名单

  • 私聊只接受 Owner 和 GROK_BOT_ALLOWED_USERS。
  • 群聊只接受 GROK_BOT_ALLOWED_GROUPS。

白名单外的消息不记录、不推送,MCP 也不能向其发送。

路由

会话标识为 group:<群号>、private:<QQ号>、channel:<guild>/<channel>。路由按顺序匹配(fnmatch),首个命中的生效;未命中的会话不推送。

[
  {
    "name": "owner",
    "sessions": ["private:*"],
    "webhook_url": "https://api2.cursor.sh/automations/webhook/<routine-id>",
    "webhook_key": "crsr_xxx",
    "owner_trigger": "always"
  },
  {
    "name": "groups",
    "sessions": ["group:*"],
    "webhook_url": "https://api2.cursor.sh/automations/webhook/<routine-id>",
    "webhook_key": "crsr_xxx",
    "flush_interval": 300,
    "flush_size": 30,
    "max_pending": 100
  }
]
字段 必填 默认值 说明
name 否 default 路由名,出现在推送内容和日志中
sessions 否 ["*"] 会话匹配规则
webhook_url 是 无 Routine 的 Webhook 地址
webhook_key 否 无 Routine 的 key,以 Authorization: Bearer <key> 发送
owner_trigger 否 to_me Owner 消息何时立即推送:always / to_me / never
flush_interval 否 无 非 Owner 消息积压多少秒后推送
flush_size 否 无 非 Owner 消息积压多少条后推送
max_pending 否 100 积压消息上限,超出丢弃最旧的

推送时机:

  • Owner 的消息:按路由的 owner_trigger 决定是否立即推送(并带上该会话中尚未推送的消息)。
    • always:Owner 任何发言都推送,适合私聊和特殊群。
    • to_me(默认):仅 @bot、回复 bot 或私聊时推送,群里普通发言不推送。
    • never:Owner 也不触发。
  • 其他人的消息:先积压,满 flush_size 条或第一条积压消息之后过了 flush_interval 秒时推送;两者都不设置时,只作为上下文等 Owner 触发。
  • bot 自己发出的消息:只记入上下文,不触发推送。

🎉 使用

Webhook 推送格式

{
  "route": "groups",
  "trigger": "owner",
  "session": "group:123456",
  "messages": [
    {
      "session": "group:123456",
      "message_id": "1001",
      "time": "2026-10-10T18:00:00+08:00",
      "sender": {"user_id": "10000", "nickname": "Yan", "is_owner": true, "is_self": false},
      "to_me": false,
      "segments": [
        {"type": "text", "text": "看看这个"},
        {"type": "image", "url": "https://multimedia.nt.qq.com.cn/download?appid=1407&fileid=…&rkey=…", "sticker": false},
        {"type": "emoji", "id": "14", "name": "微笑"}
      ]
    }
  ]
}

trigger 为 owner / size / interval。图片直接给原始链接,插件不缓存。QQ 图片链接里的 rkey 会过期,通过 MCP get_image(url) 查看或在 send_message 中转发时,插件会自动调用 get_rkey 重新签发(需要 NapCat / LLOneBot 等支持该扩展 API 的实现)。

MCP 工具

工具 说明
send_message(session, segments, reply_to?, self_id?) 发送消息,消息段类型有 text / image(url / base64)/ emoji / sticker / at / at_all
get_history(session, limit) 会话最近消息,格式同 Webhook
get_image(url, session?) 查看图片,QQ 链接自动续签 rkey
list_sessions() 收到过消息的会话
list_emojis() QQ 内置表情 ID → 名称
search_stickers(query, session, limit) 搜索本地表情包(需 savepic)
view_sticker(name, session) 查看表情包图片(需 savepic)

开发

uv sync
uv run pytest
uv run python bot.py

Metadata

Release files for nonebot-plugin-grok-bot 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nonebot-plugin-grok-bot 0.1.1
File Size Uploaded Provenance Actions
nonebot_plugin_grok_bot-0.1.1.tar.gz 17.6 kB With provenance Details for nonebot_plugin_grok_bot-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nonebot-plugin-grok-bot 0.1.1
File Interpreter ABI Platform Actions
nonebot_plugin_grok_bot-0.1.1-py3-none-any.whl Python 3 none any Details for nonebot_plugin_grok_bot-0.1.1-py3-none-any.whl

Total release size: 43.9 kB

Release files / nonebot_plugin_grok_bot-0.1.1.tar.gz

Download URL nonebot_plugin_grok_bot-0.1.1.tar.gz
Size 17.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0e2e5b270bb753a5f7a6e15998a3630aa22c687f4949039f8c0e39e1a62ea050
BLAKE2b-256 checksum
How to use checksums
169f1a1f8627f41d9f3cd3bce689e0f890afa99d52d0af462cf1a9eca0226ecf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release files / nonebot_plugin_grok_bot-0.1.1-py3-none-any.whl

Download URL nonebot_plugin_grok_bot-0.1.1-py3-none-any.whl
Size 26.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9190bbe8876d2ccce3a44303e405a5a080e7fca8abfc8853d2c90898da47d588
BLAKE2b-256 checksum
How to use checksums
eaada4d5473bc7a6b1c37ae4d7e6a43349c22f2641e3cfaf95bd7ffc79f26d0d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Security for nonebot-plugin-grok-bot 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for nonebot_plugin_grok_bot-0.1.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page