mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-01 01:51:44 +00:00
289cc47631
Broad drift audit against origin/main (b52b63396).
Reference pages (most user-visible drift):
- slash-commands: add /busy, /curator, /footer, /indicator, /redraw, /steer
that were missing; drop non-existent /terminal-setup; fix /q footnote
(resolves to /queue, not /quit); extend CLI-only list with all 24
CLI-only commands in the registry
- cli-commands: add dedicated sections for hermes curator / fallback /
hooks (new subcommands not previously documented); remove stale
hermes honcho standalone section (the plugin registers dynamically
via hermes memory); list curator/fallback/hooks in top-level table;
fix completion to include fish
- toolsets-reference: document the real 52-toolset count; split browser
vs browser-cdp; add discord / discord_admin / spotify / yuanbao;
correct hermes-cli tool count from 36 to 38; fix misleading claim
that hermes-homeassistant adds tools (it's identical to hermes-cli)
- tools-reference: bump tool count 55 -> 68; add 7 Spotify, 5 Yuanbao,
2 Discord toolsets; move browser_cdp/browser_dialog to their own
browser-cdp toolset section
- environment-variables: add 40+ user-facing HERMES_* vars that were
undocumented (--yolo, --accept-hooks, --ignore-*, inference model
override, agent/stream/checkpoint timeouts, OAuth trace, per-platform
batch tuning for Telegram/Discord/Matrix/Feishu/WeCom, cron knobs,
gateway restart/connect timeouts); dedupe the Cron Scheduler section;
replace stale QQ_SANDBOX with QQ_PORTAL_HOST
User-guide (top level):
- cli.md: compression preserves last 20 turns, not 4 (protect_last_n: 20)
- configuration.md: display.platforms is the canonical per-platform
override key; tool_progress_overrides is deprecated and auto-migrated
- profiles.md: model.default is the config key, not model.model
- sessions.md: CLI/TUI session IDs use 6-char hex, gateway uses 8
- checkpoints-and-rollback.md: destructive-command list now matches
_DESTRUCTIVE_PATTERNS (adds rmdir, cp, install, dd)
- docker.md: the container runs as non-root hermes (UID 10000) via
gosu; fix install command (uv pip); add missing --insecure on the
dashboard compose example (required for non-loopback bind)
- security.md: systemctl danger pattern also matches 'restart'
- index.md: built-in tool count 47 -> 68
- integrations/index.md: 6 STT providers, 8 memory providers
- integrations/providers.md: drop fictional dashscope/qwen aliases
Features:
- overview.md: 9 image models (not 8), 9 TTS providers (not 5),
8 memory providers (Supermemory was missing)
- tool-gateway.md: 9 image models
- tools.md: extend common-toolsets list with search / messaging /
spotify / discord / debugging / safe
- fallback-providers.md: add 6 real providers from PROVIDER_REGISTRY
(lmstudio, kimi-coding-cn, stepfun, alibaba-coding-plan,
tencent-tokenhub, azure-foundry)
- plugins.md: Available Hooks table now includes on_session_finalize,
on_session_reset, subagent_stop
- built-in-plugins.md: add the 7 bundled plugins the page didn't
mention (spotify, google_meet, three image_gen providers, two
dashboard examples)
- web-dashboard.md: add --insecure and --tui flags
- cron.md: hermes cron create takes positional schedule/prompt, not
flags
Messaging:
- telegram.md: TELEGRAM_WEBHOOK_SECRET is now REQUIRED when
TELEGRAM_WEBHOOK_URL is set (gateway refuses to start without it
per GHSA-3vpc-7q5r-276h). Biggest user-visible drift in the batch.
- discord.md: HERMES_DISCORD_TEXT_BATCH_SPLIT_DELAY_SECONDS default
is 2.0, not 0.1
- dingtalk.md: document DINGTALK_REQUIRE_MENTION /
FREE_RESPONSE_CHATS / MENTION_PATTERNS / HOME_CHANNEL /
ALLOW_ALL_USERS that the adapter supports
- bluebubbles.md: drop fictional BLUEBUBBLES_SEND_READ_RECEIPTS env
var; the setting lives in platforms.bluebubbles.extra only
- qqbot.md: drop dead QQ_SANDBOX; add real QQ_PORTAL_HOST and
QQ_GROUP_ALLOWED_USERS
- wecom-callback.md: replace 'hermes gateway start' (service-only)
with 'hermes gateway' for first-time setup
Developer-guide:
- architecture.md: refresh tool/toolset counts (61/52), terminal
backend count (7), line counts for run_agent.py (~13.7k), cli.py
(~11.5k), main.py (~10.4k), setup.py (~3.5k), gateway/run.py
(~12.2k), mcp_tool.py (~3.1k); add yuanbao adapter, bump platform
adapter count 18 -> 20
- agent-loop.md: run_agent.py line count 10.7k -> 13.7k
- tools-runtime.md: add vercel_sandbox backend
- adding-tools.md: remove stale 'Discovery import added to
model_tools.py' checklist item (registry auto-discovery)
- adding-platform-adapters.md: mark send_typing / get_chat_info as
concrete base methods; only connect/disconnect/send are abstract
- acp-internals.md: ACP sessions now persist to SessionDB
(~/.hermes/state.db); acp.run_agent call uses
use_unstable_protocol=True
- cron-internals.md: gateway runs scheduler in a dedicated background
thread via _start_cron_ticker, not on a maintenance cycle; locking
is cross-process via fcntl.flock (Unix) / msvcrt.locking (Windows)
- gateway-internals.md: gateway/run.py ~12k lines
- provider-runtime.md: cron DOES support fallback (run_job reads
fallback_providers from config)
- session-storage.md: SCHEMA_VERSION = 11 (not 9); add migrations
10 and 11 (trigram FTS, inline-mode FTS5 re-index); add
api_call_count column to Sessions DDL; document messages_fts_trigram
and state_meta in the architecture tree
- context-compression-and-caching.md: remove the obsolete 'context
pressure warnings' section (warnings were removed for causing
models to give up early)
- context-engine-plugin.md: compress() signature now includes
focus_topic param
- extending-the-cli.md: _build_tui_layout_children signature now
includes model_picker_widget; add to default layout
Also fixed three pre-existing broken links/anchors the build warned
about (docker.md -> api-server.md, yuanbao.md -> cron-jobs.md and
tips#background-tasks, nix-setup.md -> #container-aware-cli).
Regenerated per-skill pages via website/scripts/generate-skill-docs.py
so catalog tables and sidebar are consistent with current SKILL.md
frontmatter.
docusaurus build: clean, no broken links or anchors.
123 lines
4.5 KiB
Markdown
123 lines
4.5 KiB
Markdown
# QQ Bot
|
|
|
|
Connect Hermes to QQ via the **Official QQ Bot API (v2)** — supporting private (C2C), group @-mentions, guild, and direct messages with voice transcription.
|
|
|
|
## Overview
|
|
|
|
The QQ Bot adapter uses the [Official QQ Bot API](https://bot.q.qq.com/wiki/develop/api-v2/) to:
|
|
|
|
- Receive messages via a persistent **WebSocket** connection to the QQ Gateway
|
|
- Send text and markdown replies via the **REST API**
|
|
- Download and process images, voice messages, and file attachments
|
|
- Transcribe voice messages using Tencent's built-in ASR or a configurable STT provider
|
|
|
|
## Prerequisites
|
|
|
|
1. **QQ Bot Application** — Register at [q.qq.com](https://q.qq.com):
|
|
- Create a new application and note your **App ID** and **App Secret**
|
|
- Enable the required intents: C2C messages, Group @-messages, Guild messages
|
|
- Configure your bot in sandbox mode for testing, or publish for production
|
|
|
|
2. **Dependencies** — The adapter requires `aiohttp` and `httpx`:
|
|
```bash
|
|
pip install aiohttp httpx
|
|
```
|
|
|
|
## Configuration
|
|
|
|
### Interactive setup
|
|
|
|
```bash
|
|
hermes gateway setup
|
|
```
|
|
|
|
Select **QQ Bot** from the platform list and follow the prompts.
|
|
|
|
### Manual configuration
|
|
|
|
Set the required environment variables in `~/.hermes/.env`:
|
|
|
|
```bash
|
|
QQ_APP_ID=your-app-id
|
|
QQ_CLIENT_SECRET=your-app-secret
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Description | Default |
|
|
|---|---|---|
|
|
| `QQ_APP_ID` | QQ Bot App ID (required) | — |
|
|
| `QQ_CLIENT_SECRET` | QQ Bot App Secret (required) | — |
|
|
| `QQBOT_HOME_CHANNEL` | OpenID for cron/notification delivery | — |
|
|
| `QQBOT_HOME_CHANNEL_NAME` | Display name for home channel | `Home` |
|
|
| `QQ_ALLOWED_USERS` | Comma-separated user OpenIDs for DM access | open (all users) |
|
|
| `QQ_GROUP_ALLOWED_USERS` | Comma-separated group OpenIDs for group access | — |
|
|
| `QQ_ALLOW_ALL_USERS` | Set to `true` to allow all DMs | `false` |
|
|
| `QQ_PORTAL_HOST` | Override the QQ portal host (set to `sandbox.q.qq.com` for sandbox routing) | `q.qq.com` |
|
|
| `QQ_STT_API_KEY` | API key for voice-to-text provider | — |
|
|
| `QQ_STT_BASE_URL` | Base URL for STT provider | `https://open.bigmodel.cn/api/coding/paas/v4` |
|
|
| `QQ_STT_MODEL` | STT model name | `glm-asr` |
|
|
|
|
## Advanced Configuration
|
|
|
|
For fine-grained control, add platform settings to `~/.hermes/config.yaml`:
|
|
|
|
```yaml
|
|
platforms:
|
|
qq:
|
|
enabled: true
|
|
extra:
|
|
app_id: "your-app-id"
|
|
client_secret: "your-secret"
|
|
markdown_support: true # enable QQ markdown (msg_type 2). Config-only; no env-var equivalent.
|
|
dm_policy: "open" # open | allowlist | disabled
|
|
allow_from:
|
|
- "user_openid_1"
|
|
group_policy: "open" # open | allowlist | disabled
|
|
group_allow_from:
|
|
- "group_openid_1"
|
|
stt:
|
|
provider: "zai" # zai (GLM-ASR), openai (Whisper), etc.
|
|
baseUrl: "https://open.bigmodel.cn/api/coding/paas/v4"
|
|
apiKey: "your-stt-key"
|
|
model: "glm-asr"
|
|
```
|
|
|
|
## Voice Messages (STT)
|
|
|
|
Voice transcription works in two stages:
|
|
|
|
1. **QQ built-in ASR** (free, always tried first) — QQ provides `asr_refer_text` in voice message attachments, which uses Tencent's own speech recognition
|
|
2. **Configured STT provider** (fallback) — If QQ's ASR doesn't return text, the adapter calls an OpenAI-compatible STT API:
|
|
|
|
- **Zhipu/GLM (zai)**: Default provider, uses `glm-asr` model
|
|
- **OpenAI Whisper**: Set `QQ_STT_BASE_URL` and `QQ_STT_MODEL`
|
|
- Any OpenAI-compatible STT endpoint
|
|
|
|
## Troubleshooting
|
|
|
|
### Bot disconnects immediately (quick disconnect)
|
|
|
|
This usually means:
|
|
- **Invalid App ID / Secret** — Double-check your credentials at q.qq.com
|
|
- **Missing permissions** — Ensure the bot has the required intents enabled
|
|
- **Sandbox-only bot** — If the bot is in sandbox mode, it can only receive messages from QQ's sandbox test channel
|
|
|
|
### Voice messages not transcribed
|
|
|
|
1. Check if QQ's built-in `asr_refer_text` is present in the attachment data
|
|
2. If using a custom STT provider, verify `QQ_STT_API_KEY` is set correctly
|
|
3. Check gateway logs for STT error messages
|
|
|
|
### Messages not delivered
|
|
|
|
- Verify the bot's **intents** are enabled at q.qq.com
|
|
- Check `QQ_ALLOWED_USERS` if DM access is restricted
|
|
- For group messages, ensure the bot is **@mentioned** (group policy may require allowlisting)
|
|
- Check `QQBOT_HOME_CHANNEL` for cron/notification delivery
|
|
|
|
### Connection errors
|
|
|
|
- Ensure `aiohttp` and `httpx` are installed: `pip install aiohttp httpx`
|
|
- Check network connectivity to `api.sgroup.qq.com` and the WebSocket gateway
|
|
- Review gateway logs for detailed error messages and reconnect behavior
|