get_joint_config

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

With no annotations, the description carries the burden. It implies read-only via 'diagnostic tool' and lists returned data. Does not explicitly state no side effects, but the context suggests it is safe.

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?

Well-structured with a clear purpose sentence, bullet-point usage guidelines, and an args section. No redundant information.

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?

Comprehensive for a diagnostic tool with one parameter: covers return fields, usage context, and parameter detail. Output schema exists so return values need not be detailed in description.

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?

Adds significant meaning to the single parameter 'prim_path' by specifying it is a USD path to the robot articulation root, which is not clear from schema title alone.

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?

Clearly states it is a diagnostic tool that returns joint drive configuration, including stiffness, damping, limits, and position error. Distinguishes from sibling tools like get_joint_positions which only return positions.

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?

Provides explicit scenarios for use (tracking issues, oscillation, limit hits). Lacks mention of when not to use or explicit alternative tool name, but the context is clear.

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