dataverse_get_sdk_message

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, indicating safe read-only behavior. The description adds valuable context about the exact mapping (name to ID) and its role in plugin step creation, going beyond what annotations provide. No contradictions.

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 sentences plus a concise requirement line. It immediately states the core function and use case, with no fluff. Every sentence serves a purpose.

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 (a lookup with two optional parameters) and the presence of an output schema (mentioned), the description covers the essential purpose, input constraints, and usage context. It is complete for an agent to select and invoke 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?

Although the input schema provides descriptions for each parameter (100% coverage by default), the description adds a crucial constraint: 'Provide message_name OR message_id — exactly one required.' This clarifies the mutual exclusivity, which is not enforced by the schema (both are optional individually). Thus it adds meaningful guidance.

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 'resolve', the resource 'SDK message', and the specific output 'sdkmessageid'. It also mentions the downstream use case (required by dataverse_create_plugin_step), distinguishing it from sibling tools like dataverse_list_sdk_messages.

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 explicitly says 'Call this to get the message_id required by dataverse_create_plugin_step' and specifies 'Provide message_name OR message_id — exactly one required.' This gives clear context for when to use. It could benefit from stating when not to use, but it is already effective.

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