get_element

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

No annotations are provided, so the description carries the full burden. It states the operation is a retrieval (read-only) and discloses the return content. It does not mention error handling or edge cases, but for a simple get-by-ID tool, this is adequate and transparent.

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?

A single, concise sentence that front-loads the verb and resource, immediately states the key identifier (local ID), and lists the return fields. There is no wasted wording or repetition.

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 single-parameter retrieval tool, the description covers input (via ID) and output (type, name, owner ID). The output schema is present (though not shown), and the description already outlines the return values. It does not discuss failure modes or prerequisites, but these are not critical for this simple operation.

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 0%, so the description must add meaning to the sole parameter element_id. It adds the qualifier 'local ID', clarifying that the ID is scoped locally rather than globally, which is valuable beyond the schema's vague 'Element Id'. It does not provide format or examples, but the added context is significant.

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 'Retrieve', the resource 'a single SysML v1 element', and the distinguishing scope 'by its local ID'. It also lists the return fields (type, name, owner ID), making the purpose unambiguous and differentiating it from sibling tools that search by name or type.

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 when you have a local ID, but it does not explicitly state when to prefer this tool over alternatives like find_by_name, find_by_type, describe_element, or get_element_structure. Given the large sibling set, explicit routing or exclusions would be beneficial, but the ID-based retrieval is reasonably implied.

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