dataverse_get_relationship

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

Annotations already indicate it is read-only, idempotent, and non-destructive. The description adds that it returns 'full metadata' including cascade configuration and navigation properties, and frames it as a precursor to updates, conveying additional behavioral context.

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 two concise sentences: the first states the purpose with key details, the second provides crucial usage guidance. Every word is necessary; no redundancy or fluff.

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 the tool's simplicity, good annotations, and existing output schema, the description covers the core purpose and usage workflow. It could optionally mention the 'consistency_strong' parameter, but the schema handles that. Overall, it is sufficiently complete for a read 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?

The tool description does not explicitly describe any parameters (0% coverage per context). However, the input schema provides detailed descriptions for each parameter, so agents can infer semantics from the schema. At baseline 3, the description adds no extra value but does not hinder understanding.

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 tool retrieves full metadata for a single relationship by schema name, specifying cascade configuration and navigation properties. It distinguishes itself from sibling tools like 'dataverse_list_relationships' by focusing on a single relationship and providing detailed definition.

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?

Explicitly states that schema names are case-sensitive and advises using the exact SchemaName from 'dataverse_list_relationships'. It also instructs to use this tool before updating with 'dataverse_update_relationship', providing clear when-to-use guidance.

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