Skip to main content
Glama
OmniQQ-MCP

OmniQQ-MCP

by haoan33

check_napcat_environment

Read-onlyIdempotent

Checks local NapCatQQ runtime, OneBot ports 3000/3001, cached accounts, and latest GitHub release to diagnose connection failures and update needs.

Instructions

检查本地 NapCatQQ 运行时安装状态、OneBot 端口 (3000/3001) 监听情况、本地缓存账号列表,并请求 GitHub Release API 对比官方最新版本。 适用场景:首次连接、排查接口调用失败或判断是否有新版本可升级时优先调用。不适用与替代:若仅需读取当前在线 QQ 的 user_id 与昵称,请改用轻量级的 get_login_info(无需请求 GitHub,速度更快)。 行为与返回:纯只读无副作用操作(包含一次约 5 秒超时的外部 GitHub 版本探测);返回包含 installed、port_listening、cached_accounts、latest_release 及 needs_update 诊断结论的字典,失败时在相应字段返回原因。

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": "check_napcat_environment"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.2
    • 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 safety profile is covered; the description still adds non-obvious context the annotations cannot convey: a ~5-second timeout on the external GitHub probe and the fact that failures are reported per-field rather than raising. It does not describe caching of results or what happens when the network is fully offline, which keeps it from a 5.

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?

Three labeled blocks (purpose, usage/alternative, behavior/return) keep it scannable and the core purpose is front-loaded in the first sentence. The return-field enumeration overlaps with the existing output schema, which is mild redundancy, but the description stays free of filler.

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 no-argument diagnostic tool, the description covers what is measured, when to prefer it, the sibling to use instead, the external-call latency, and how failures surface. With an output schema present it need not document return values in detail, yet it still names the diagnostic fields, so nothing an agent needs before calling is missing.

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?

The tool takes zero parameters and the input schema is an empty closed object, so there are no parameter semantics to explain and no risk of mis-invocation. Baseline for a no-parameter tool applies; nothing further is required.

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?

The description gives a precise verb ('检查') plus a clearly scoped resource and enumerates the four concrete checks performed: install status, ports 3000/3001 listening, cached account list, and GitHub Release version comparison. It also names the sibling `get_login_info` as the narrower alternative, so an agent can distinguish it from every other tool in the list.

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?

Explicit triggers are given ('首次连接、排查接口调用失败或判断是否有新版本可升级时优先调用'), and an explicit exclusion with a named substitute follows: if you only need the online QQ user_id/nickname, use `get_login_info` instead because it skips the GitHub call. Both the when and the when-not are stated rather than inferred.

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