get_wan_pppoe_log

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

The annotation readOnlyHint=true already declares the read-only nature. The description adds no additional behavioral context, such as log size limits, time range, or output format. It does not go beyond what the annotation already provides, and no extra safety or side-effect information is disclosed.

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

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

The description is a single, clear sentence with no filler or redundancy. It is concise and front-loaded, immediately stating the tool's purpose.

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

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

Given a zero-parameter input schema, a readOnlyHint annotation, and an existing output schema (not shown), the description is sufficient for basic invocation. However, it is very terse and could benefit from mentioning that it retrieves PPPoE dial logs for the WAN interface specifically, which the name already implies but the description conveys in a minimal way. Overall, adequate for a simple getter.

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

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

The tool has zero parameters, so the schema fully covers the input. The description does not need to explain parameters. With no params, the baseline is 4, and there is nothing missing in parameter semantics.

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

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

The description '获取外网拨号日志' clearly states the action (get) and resource (WAN dial-up/PPPoE log), using a specific verb and noun phrase. It distinguishes this tool from sibling log retrieval tools like get_arp_log and get_auth_log by specifying the WAN PPPoE log type.

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

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

The description provides no guidance on when to use this tool versus alternatives. It does not mention any context, prerequisites, or exclusions. For a simple log getter, usage is implied, but the lack of explicit guidance, especially given the many sibling log tools, leaves the agent without clear selection criteria.

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