coolify_update_notification

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

The description discloses meaningful behavioral traits beyond the annotations: PATCH semantics, credential non-echo/logging policy, operation mode and production guard constraints, and an audit identifier. These are valuable for a write operation, even though it doesn't cover return values or error specifics.

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 compact and front-loaded, with each sentence adding distinct value: purpose, PATCH semantics, credential security, guard policies, and audit trail. There is no unnecessary padding.

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?

The description is incomplete for a write-only, zero-parameter tool. It doesn't explain what notification settings are, how a channel is selected, or what success looks like. The security and policy notes are helpful but leave the core functionality underexplained.

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 has zero properties, but the description mentions 'channel' without explaining how the tool identifies the target. This creates ambiguity about what the agent should provide or what action is implied. The description fails to clarify the parameter semantics for a zero-parameter tool.

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 and resource: 'Update notification settings for a channel,' and adds 'PATCH semantics' to clarify the update method. It is distinct from sibling update tools on other resources, though it doesn't explicitly call out the differentiation.

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?

No explicit guidance on when to use this tool versus alternatives. It does not mention `coolify_list_notifications` or other notification-related tools, and provides no prerequisites or exclusions. The only contextual note is about mode/guard policies, which is more about constraints than usage direction.

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