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

With no annotations provided, the description carries the burden of behavioral disclosure. It reveals that data is 'fetched from external TypeScript API docs' and that the component name can be in any format (normalization behavior). However, it does not disclose potential network dependency failures, error handling, or whether any state is modified (though retrieval is clearly read-only).

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 two sentences, front-loaded with the primary action, and contains no fluff. It efficiently communicates the purpose and a key parameter flexibility without 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?

For a simple 2-parameter retrieval tool with full schema coverage, the description is nearly complete. It explains the external source and name flexibility. The only minor gap is not explicitly noting that an external network connection is required, but the phrase 'fetching from external TypeScript API docs' implies this. Overall, combined with the schema, it is contextually sufficient.

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% for both parameters, including examples for component_name and an enum with descriptions for vaadin_version. The description adds 'The component name can be in any format', but this is already demonstrated by the schema's examples, so it adds minimal additional meaning beyond what the schema provides.

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's action: 'Returns the Web Component/TypeScript API documentation for a specific Vaadin component'. It specifies both the resource (Web Component/TypeScript API documentation) and the scope (specific Vaadin component), and the 'Web Component/TypeScript' qualifier distinguishes it from sibling tools like get_component_java_api and get_component_react_api.

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 implies usage for TypeScript/Web Component API retrieval, and the sibling tool names suggest alternatives. However, there is no explicit guidance on when to use this tool versus the Java/React API tools, or any exclusions. The context is clear but not elaborated.

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