Skip to main content
Glama

连通性与凭据自检

gwl_ping
Read-onlyIdempotent

Validates the configured user ID and API key and returns identity details, server time, and effective read, write, IP, and auth-failure rate limits for planning API calls.

Instructions

验证当前 userid + apikey 是否可用,并返回身份信息与本进程生效的限流口径。 凭据(GWL_USER_ID / GWL_API_KEY)来自环境变量,工具参数里不需要也不能传 userid/apikey。 建议每次会话开始时先调用一次:它同时告诉你上游的读/写/IP 配额,便于安排后续调用节奏。返回 data 含 userid、username、real_level(1~5)、server_time(UTC ISO)、rate_limit{read_per_minute,write_per_minute,ip_per_minute,auth_fail_per_minute}。

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and openWorld, so the safety profile is covered. The description adds genuinely new behavioral context: credentials come from environment variables and cannot be passed as parameters, and the call reports per-minute read/write/IP/auth-failure quotas. It does not describe error behavior on invalid credentials, which keeps it at 4.

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 sentences, front-loaded with the purpose, then the credential constraint, then the recommended cadence. The final enumeration of return fields overlaps the existing output schema and is the one part that does not fully earn its place.

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

Completeness4/5

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

For a zero-parameter, read-only probe with both annotations and an output schema, the definition covers purpose, auth source, cadence and quota semantics. The only omission is how failure modes (bad key) surface, and the return-field list is largely redundant with the output schema.

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

Parameters5/5

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

Zero parameters sets a baseline of 4, and the description goes beyond that by explaining why the schema is empty: GWL_USER_ID and GWL_API_KEY are read from the environment and must not be supplied as arguments. This prevents an agent from hunting for auth parameters that do not exist.

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

Purpose4/5

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

The description gives a specific verb and resource: verify the current userid + apikey and return identity plus effective rate-limit quotas. That is concrete enough for an agent to select it without opening the schema. It does not, however, distinguish itself from gwl_get_me, which plausibly returns overlapping identity data, so it falls short of a 5.

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

Usage Guidelines4/5

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

Explicit timing guidance is provided ('建议每次会话开始时先调用一次'), along with the reason (learn read/write/IP quotas to pace later calls). There is no when-not guidance and no named alternative for identity lookup, so it stops short of the 5 bar.

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