获取 Element Plus 组件文档

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

The description discloses that the result is Chinese official documentation in Markdown format, which is useful behavioral context. However, with no annotations, it does not mention caching, network calls, or potential side effects, even though the force_refresh parameter implies caching behavior. The description adds some value but not comprehensive transparency.

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, focused sentence that is front-loaded with the verb '获取' (get). It conveys purpose and output format without any filler or redundancy.

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?

The tool is simple and the description adequately covers the core functionality and output format, which is helpful given no output schema exists. It could be more complete by referencing sibling tools or edge cases, but overall it is sufficient for this low-complexity tool.

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 the baseline is 3. The description mentions '中英文名或 slug' but the schema's parameter description already provides examples like 'button, Button, 按钮, date-picker', covering this. No additional parameter meaning is added beyond the schema.

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 tool retrieves the Chinese official Element Plus documentation based on a component's Chinese/English name or slug, with output formatted as Markdown suitable for models. This specific verb-resource-scope pairing distinguishes it from siblings like list_components and search_component_docs.

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 conveys that this tool is for fetching a specific component's documentation by name/slug, giving clear context. However, it does not explicitly mention alternatives or exclusion criteria, such as using search_component_docs when the exact name is unknown.

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