eda_lib_device_get_by_lcsc_ids

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

With no annotations, the description carries the behavioral burden and does well: it discloses the default first-match behavior, the effect of allowMultiMatch on the return shape, the private-deployment restriction, and that the result is device properties. It could add error behavior or permissions, but the key operational traits are covered.

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 compact and front-loaded with the signature, followed by a few purposeful remarks. The mixed-language signature line is dense but necessary, and there is minimal filler.

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 there is no output schema, the description supplies the return type, a return-value summary, and a critical environment limitation. It lacks an example or explanation of libraryUuid, but an agent can still invoke the tool correctly for the common LCSC-ID lookup case.

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 input schema only exposes generic args/windowId, so the description's signature is the real parameter documentation: lcscIds, libraryUuid?, and allowMultiMatch?. It explains allowMultiMatch's effect in the remarks, but libraryUuid's meaning and the exact expected format of lcscIds are not elaborated.

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 specific verb and resource: it fetches a device using the LCSC C-number. The included method signature makes the operation unambiguous and distinguishes this lookup from the broader eda_lib_device_get/search siblings.

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 makes it clear that this is for retrieving devices by LCSC C-number and flags that it is not available in private deployments. However, it does not explicitly contrast this tool with eda_lib_device_get, eda_lib_device_search, or search_by_properties, so when-not-to-use guidance is only implied.

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