Skip to main content
Glama
OmniQQ-MCP

OmniQQ-MCP

by haoan33

get_group_list

Read-onlyIdempotent

Retrieve all QQ groups joined by the current account, including group ID, name, member count, and capacity. Use it before sending group messages or files to find the right group_id by name.

Instructions

获取当前登录 QQ 账号已加入的全部 QQ 群列表,包含每群的 group_id、group_name、member_count 与 max_member_count (OneBot 11: get_group_list)。 适用场景:在发送群消息或上传群文件前,根据群名称查找对应的 group_id 或遍历已加入的群聊。不适用与替代:若已知具体 group_id 仅需查询该单群的详细资料或需查询好友列表,请通过 call_napcat_api 调用 get_group_info 或 get_friend_list。 参数约束与行为:no_cache=True(默认)会强制向 QQ 服务器拉取最新群列表以确保新加入的群立即可见;纯只读无副作用操作,成功在 data 中返回群信息字典数组。

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_group_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
no_cacheNo为 True 时绕过本地缓存强制从服务器刷新最新群列表,为 False 时优先使用缓存,默认 True

Output Schema

NameRequiredDescriptionDefault
dataNo接口返回的业务负载数据(对象或数组,具体字段依工具而定)
statusNo执行状态标识,成功为 'ok'(或特定生命周期状态),失败为 'failed' 或 'error'
messageNo状态说明或错误诊断详情
retcodeNoOneBot 11 响应状态码,0 表示成功,非 0 表示协议端或网络错误

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.2
    • changedInput schema / properties / no_cache / description
      Previous value: -"是否强制刷新最新群列表而不使用缓存,默认 True"New value: +"为 True 时绕过本地缓存强制从服务器刷新最新群列表,为 False 时优先使用缓存,默认 True"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "data": {
      +      "description": "接口返回的业务负载数据(对象或数组,具体字段依工具而定)"
      +    },
      +    "message": {
      +      "description": "状态说明或错误诊断详情",
      +      "type": "string"
      +    },
      +    "retcode": {
      +      "description": "OneBot 11 响应状态码,0 表示成功,非 0 表示协议端或网络错误",
      +      "type": "integer"
      +    },
      +    "status": {
      +      "description": "执行状态标识,成功为 'ok'(或特定生命周期状态),失败为 'failed' 或 'error'",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed1 schema field changedv1.1.0
    • addedInput schema / additionalProperties
      Added value: +false
  3. First observedv1.0.0

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the description only needs to add context — and it does, explaining that no_cache=True forces a server-side refresh so newly joined groups appear immediately, and that the call has no side effects. It also notes results land in `data`, though with an output schema present that is redundant rather than essential.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the core purpose, then uses labeled segments (scenario, exclusions, parameter/behavior) that are easy to scan. Slightly verbose in restating the OneBot action name and return field list, but no sentence is genuinely wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single optional boolean parameter with an output schema and full annotation coverage, the description supplies everything an agent needs: what it returns, when to reach for it, when to route elsewhere, and the caching tradeoff. No material gap remains.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already defines no_cache and its default. The description goes beyond it by giving the operational consequence of each setting — bypass cache for the freshest list versus preferring cache — which helps an agent pick a value rather than just know the type.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: fetch the full list of QQ groups joined by the currently logged-in account, and enumerates the returned fields (group_id, group_name, member_count, max_member_count) plus the OneBot 11 action name. It also names the sibling path (call_napcat_api for get_group_info / get_friend_list), so an agent can separate it from other lookup tools without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit when-to-use scenario (resolve a group name to a group_id, or enumerate joined groups, before send_group_msg or upload_group_file) and an explicit when-not-to-use condition (known group_id needing single-group detail, or needing the friend list → call_napcat_api). Nothing is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.