Unraid API oidcProvider

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

Annotations already cover read-only, idempotent, non-destructive behavior. The description adds meaningful behavioral context by disclosing that the client secret is deliberately excluded from the response, which is not visible from the annotations alone.

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?

A single concise sentence with no filler. The core action and the key exclusion are both communicated efficiently and front-loaded.

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?

For a simple one-parameter read operation with strong safety annotations, the description is largely sufficient. It does not describe error behavior or response shape, but the tool's simplicity and the clarity of 'configuration' make those gaps minor.

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 schema provides only a required 'id' string with no description, and the tool description does not explicitly explain what the ID represents. The phrase 'Get one OIDC provider configuration' implies the ID selects the provider, but no additional meaning or format guidance is added for the parameter.

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 uses a specific verb ('Get'), names the resource ('one OIDC provider configuration'), and adds a key qualifier ('without its client secret'). This clearly distinguishes it from the plural sibling tools and from secret-returning 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?

The description implies the tool is for retrieving a single provider configuration by ID, and the 'without its client secret' phrasing hints at a limitation. However, it never explicitly states when to prefer this tool over alternatives like unraid_v4371_query_oidc_providers or unraid_v4371_query_public_oidc_providers.

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