create_soap_message

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

Annotations indicate readOnlyHint=false and destructiveHint=false, meaning it's a write operation but not destructive. The description adds the prerequisite 'requires WRITE_ENABLED=true', which is useful beyond annotations. However, no other behavioral traits like side effects or authorization details are disclosed.

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 a single sentence that efficiently conveys the purpose and a key requirement. It is front-loaded and avoids unnecessary detail. However, it could be structured to highlight prerequisites more clearly.

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 tool has 8 parameters and no output schema. The description mentions a prerequisite and the type of definition, but it does not explain what a SOAP Message definition is, the return value (e.g., created record ID), or any other contextual details needed for full understanding. Annotations provide some context, but the description is minimal for a complex tool.

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 description coverage is 100% for all 8 parameters, so the description does not need to add parameter details. The description provides no additional info beyond the schema, which is acceptable given full coverage.

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 tool creates a new outbound SOAP Message definition and specifies a prerequisite (WRITE_ENABLED=true). It distinguishes from sibling tools like create_soap_message_function and create_rest_message by specifying 'outbound SOAP Message definition'.

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 provides a prerequisite (WRITE_ENABLED=true) but does not explicitly state when to use this tool vs alternatives like create_rest_message or create_soap_message_function. No when-not-to-use guidance is given.

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