dataverse_get_web_resource

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

Annotations already indicate readOnlyHint, idempotentHint, etc. The description adds critical behavior: 5 MB content cap, returns only published version, and that the RetrieveUnpublished message is unavailable. No contradictions with annotations.

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 concise paragraphs with front-loaded purpose, followed by details and an important note. No unnecessary words; every sentence provides useful 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?

Given the tool's complexity and the presence of an output schema, the description covers: what is retrieved, optional content with limits, and the critical published vs. unpublished distinction. It is fully self-contained.

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 descriptions already cover all three parameters well. The description adds extra value by noting the 5 MB limit for include_content and tying it to content size, which goes beyond the schema.

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 starts with 'Retrieve a single webresource record by its GUID,' clearly specifying the verb and resource. It enumerates the fields returned, and the nuance about published vs. unpublished distinguishes it from update or list operations.

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 this returns the published version and that unpublished edits require a separate publish step. Mentions sibling tools (dataverse_update_web_resource, dataverse_publish_customizations) and explains when to use the optional include_content parameter with a size warning.

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