Describe Redfish schema type

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

Annotations already establish read-only, idempotent, non-destructive behavior. The description adds valuable context about the bundled index artifact (suggesting offline/local data) and the return content, including URIs, properties, actions, versions, and enum metadata. It also notes the potential size of full summaries, which is a practical performance consideration.

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 and front-loaded with the main purpose. It efficiently packs the key behavioral notes and an example into four compact sentences, with 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 tool's simple scope, an output schema, and safe annotations, the description provides sufficient completeness. It clarifies the source (bundled index), narrowing options, return format, and an example, making it fully understandable for an agent.

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 covers all parameters with descriptions. The description supplements this by explaining how property_name and action_name narrow the result, and the example clarifies usage with resource_type and property_name. This adds meaning beyond the schema definitions.

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 returns distilled schema metadata for one Redfish resource type from the bundled index artifact. It distinguishes itself from sibling tools that focus on endpoint operations or live data access.

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?

It provides helpful guidance on narrowing output with property_name or action_name when full summaries are large, but does not explicitly discuss when to use this tool vs alternatives like redfish_get or list_endpoints. The usage context is implied rather than directly contrasted with siblings.

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