Create a deal

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

No annotations provided, so the description must convey behavioral traits. It merely states it's a POST request and creates a deal, but omits side effects (e.g., data mutation), permission requirements, rate limits, or return behavior. The phrase 'Body: application/json' is technical but not behavioral.

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?

Extremely concise at one sentence plus endpoint info, but this comes at the cost of missing necessary guidance. The structure is front-loaded with the action, but every word could earn its place if more content were included. It is not verbose, but under-specified.

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 lack of annotations and output schema, the description should provide a fuller picture. The complex input schema with nested objects and custom fields requires more explanation. No details on what a deal is, how statusId works, or what the response contains make the tool hard to use correctly.

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 has many properties (tags, title, amount, etc.) with 0% schema description coverage. The tool description adds no parameter explanation, leaving the agent to infer from property names alone. The only parameter context is the customFields description in the schema, not in the tool description.

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 action ('Create a deal') and the resource ('/crm/statuses/{statusId}/deals'), making the purpose evident. However, it does not distinguish this tool from siblings like 'weeek_update_a_deal' or 'weeek_get_a_deal', missing a chance to differentiate.

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 guidance on when to use this tool versus alternatives, such as when to create vs. update a deal. Also lacks prerequisites (e.g., need an existing status ID) or context about typical use cases.

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