configure_ticket_provider

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

With no annotations, the description discloses key behaviors: provider-agnostic, secret handling via credential broker, and set_active default. However, it does not detail side effects (e.g., upsert behavior, deactivation of other providers) or auth requirements beyond secrets.

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?

Well-structured with a concise summary followed by details and args list. Every sentence adds value, though it is slightly verbose. The purpose is 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?

Given the complexity (multiple providers, secrets handling) and the presence of an output schema, the description covers essential aspects for agent invocation. It could mention persistence or impact on tickets for completeness, but it is generally adequate.

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 description adds significant meaning to all 4 parameters beyond the schema (which has 0% coverage). It explains provider options, config as non-secret JSON, secret_keys mapping to credential keys, and set_active's effect, fully compensating for the lack of schema descriptions.

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 (register or update) and resource (ticketing provider configuration), and lists supported providers, distinguishing it from sibling tools like get_ticket_provider or remove_ticket_provider.

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?

Provides clear context for when to use the tool (register or update), along with critical guidelines about handling secrets out-of-band and the set_active default. It does not explicitly mention alternatives but the sibling tools cover other actions.

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