Get element or part metadata

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

The readOnlyHint annotation already signals this is a safe read operation, and the description's 'Read' is consistent with that. The description adds useful conditional behavior (element metadata vs. part metadata), but does not disclose return shape, errors, or any other runtime behavior. With annotations covering safety, this is adequate but not rich.

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 sentence that front-loads the action and resource, and efficiently handles the optional part behavior. There is no filler or redundant wording.

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 read-only metadata retrieval tool, the description plus the fully documented schema is nearly complete. There is no output schema, so a slightly more explicit statement of what kind of properties are returned would strengthen it, but nothing essential is missing for calling it correctly.

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 doc, ws, elem, and part are each already explained. The description adds no additional parameter meaning beyond restating that part changes the scope, so the baseline of 3 applies.

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 ('Read'), a clear resource ('properties of an element, or of one part'), and the conditional scope when a part id is supplied. It is immediately distinguishable from its write counterpart onshape_set_metadata and from other read tools focused on features or bodies.

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 this is the tool to use when metadata is needed, but it does not explicitly state when to prefer it over related tools like onshape_get_elements or onshape_get_parts. There are no exclusions or explicit alternative routing, so usage 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.