dataverse_list_custom_api_response_properties

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint as false. The description adds value by listing the returned fields and explaining the type enum values (0-12). It does not contradict annotations and provides specific behavioral details about the output.

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 concise with three sentences. It front-loads the purpose, then explains filtering, and finally lists returned fields and enum mappings. Every sentence adds essential information without waste.

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 annotations (readOnlyHint, etc.) and the presence of an output schema, the description adequately covers purpose, filtering criteria, return fields, and type enum. It does not need to explain pagination as the schema covers the 'top' parameter. The description fills gaps not covered by structured fields, making it complete for this simple list 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 input schema already includes descriptions for all parameters (dataverse_url, custom_api_id, top, filter) with details like bounds and default values. The description adds value by explaining the enum values for the 'type' field in the response, which is not in the schema. Since schema coverage is high (100% for parameters), the description enhances understanding without redundancy.

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 'List' and the specific resource 'response property records for a Custom API.' It distinguishes from sibling tools like dataverse_list_custom_apis or dataverse_list_custom_api_request_parameters by specifying it returns properties belonging to a Custom API.

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 explains that the tool filters by custom_api_id and allows an optional OData filter. It implicitly indicates usage when needing to list response properties of a specific Custom API. However, it does not explicitly state when not to use this tool or mention alternatives, but the context is clear given sibling tool names.

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