archimate_find_elements

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

With no annotations provided, the description carries the full burden. It discloses the key behavioral detail of case-insensitive regex matching, which is valuable. However, it does not specify return format, pagination behavior, performance implications, or whether the search is confined to certain element types beyond the optional layer filter.

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 efficient sentence, avoiding unnecessary words. It is front-loaded with the core action. Minor improvement could be to separate the case-insensitive behavior more prominently, but current form is good.

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 tool with 2 parameters and no output schema, the description covers the essential searching purpose. However, it lacks details about the return value (e.g., list of element IDs or names), error handling, or performance notes. A new user might need to experiment to understand the full behavior.

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 coverage is 100%, so baseline is 3. The description restates the parameter concepts but adds no additional detail beyond what the schema already provides (e.g., regex support is already in schema description). It does not explain regex syntax or layer enumeration values.

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 verb ('Search') and resource ('elements'), specifies the search criterion ('name pattern') and key behavioral detail ('case-insensitive regex'). It distinguishes from sibling tools like 'archimate_list_elements' (which lists all without pattern filtering) and 'archimate_get_element' (which retrieves a single element by ID).

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 pattern-based searching but does not explicitly state when to use this tool versus alternatives like 'archimate_list_elements' or 'archimate_get_element'. No exclusions, prerequisites, or comparison with siblings are provided.

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