dataverse_get_connection_reference

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

Discloses the returned fields and the significance of an empty connectionid, adding value beyond annotations that already indicate read-only and idempotent behavior.

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?

Two sentences: first states purpose and output, second provides a critical usage note. No wasted words.

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 output schema exists, the description appropriately covers the key behavioral aspect (empty connectionid) and the identification methods. Could mention prerequisites like permissions, but not essential for a read-only tool.

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 description mentions retrieval by GUID or logical name, which aligns with parameters. However, the schema already provides descriptions for each parameter, so the description adds minimal extra meaning.

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 it retrieves a single connection reference by GUID or logical name, specifying the return fields. It distinguishes from sibling 'list_connection_references' by focusing on a single record.

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 context on when to use update tool if connectionid is empty, guiding the agent. However, it does not explicitly state when not to use this tool (e.g., for multiple records).

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