ljs_read

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

There are no annotations, so the description carries the full burden; it does usefully disclose what the response contains and flags that the 'known pitfalls' section holds production hazards that produce code that compiles but runs incorrectly. It says nothing about failure behavior for unknown plugins, the freshness or versioning of the content, or response size, which matters because the guide is said to be complete.

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 front-loaded with what the tool returns, followed by when to call it and then a warning about the pitfalls section. The parenthetical examples (byte-width calculation skipping when data is empty, a 1-second internal delay in export) are illustrative rather than wasteful, though they make the third sentence heavier than needed.

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?

For a two-parameter read tool with no output schema, the description adequately conveys what comes back and why it matters. The main gap is relative to the siblings: an agent must decide between this and ljs_api, and the definition does not explain that boundary.

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?

Schema description coverage is 100%, so both parameters are already documented, and the schema even gives example values for `section`. The description's enumeration of chapters (何时用/不用、安装、可复制示例、典型错误对照、已知坑) slightly enriches the plausible values for `section` beyond the schema's two examples, but adds little else about parameter meaning.

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 states a concrete verb and resource — reading a complete usage guide for a specified LJS plugin — and lists its contents (when to use and when not to, installation, copyable examples, typical error reference, known pitfalls). It also indicates the position in the workflow ("确定要用某个包后调它"), which distinguishes it from the discovery-oriented ljs_search, though no sibling is named explicitly.

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 clearly says when to call it: after you have decided to use a package, and in one call to obtain all of its usage information. It does not state when not to use it, however, nor does it distinguish this tool from ljs_api, the other sibling that may also answer usage questions.

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