Webhook Kaydet

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

With no annotations provided, the description carries the full burden. It discloses the authentication mechanism (BASIC_AUTHENTICATION with fallback to API key/secret) and lists all subscribable statuses. However, it does not mention side effects, idempotency, or error scenarios.

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 two sentences long. The first sentence states the core purpose, and the second sentence adds essential details (status list, authentication). No redundant or unnecessary information. Every sentence earns its place.

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 covers the main purpose and auth but lacks information about the return value (e.g., webhook ID or confirmation), error handling, or prerequisites (e.g., valid API credentials). Given no output schema, the description should explain what happens after registration, which is missing.

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?

Schema coverage is 100% with descriptions for all 4 parameters. The description adds value beyond the schema by explaining the authentication fallback behavior and listing all valid statuses, which is not in the schema. This helps the agent understand parameter meaning and defaults.

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 (kaydeder - registers), resource (webhook for sipariş durum değişiklikleri - order status changes), and lists the specific statuses. This distinguishes it from sibling tools like trendyol_delete_webhook and trendyol_get_webhooks.

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 used when registering a webhook for order status changes, but it does not provide explicit guidance on when to use this tool versus alternatives (e.g., when to delete or get webhooks) or mention any prerequisites or exclusions.

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