Create Service Request

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

No annotations provided; description explains the conceptual role (intake before Work Order) and required fields but omits details like return value, idempotency, or error states. Adequate but not comprehensive.

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?

Two sentences: first states purpose, second provides essential usage requirement. No unnecessary words; highly efficient.

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 create tool with 7 parameters and no output schema, the description covers the core function and key requirement (summary + company/contact). Does not describe return value, but that is mitigated by lack of output schema. Good overall.

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 has 100% coverage with descriptions for all parameters. The description adds value by clarifying that company or contact should be associated, which is not strictly required by schema. This goes beyond mere repetition.

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?

Clearly states the verb 'create', the resource 'service Request', and distinguishes it from Work Orders as an initial intake record. This differentiates it from sibling tools like create_work_order.

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?

Mentions that at least a summary and associated company or contact are required, giving practical guidance. However, it does not explicitly state when not to use this tool or compare to alternatives like create_work_order.

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