Create an IPsec profile to define VPN encryption and authentication settings for Security Director Cloud.
Create a new IPsec profile.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON request body matching the target Security Director Cloud schema. |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full responsibility. It merely states 'create' without disclosing side effects, permissions, idempotency, or error states. Insufficient for a write operation.
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?
Description is extremely concise (one sentence), which is good for brevity but lacks necessary detail for understanding correct usage. It does not earn its place without added value.
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?
With a single parameter (body) lacking detailed schema, no output schema, and no annotations, the description is insufficient for an agent to use the tool correctly. Missing context about what the IPsec profile requires or returns.
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?
Input schema has 100% coverage but only describes the 'body' parameter as a JSON object with no further details. The description adds no additional meaning beyond the schema, failing to compensate for the lack of parameter structure or constraints.
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?
Description clearly states 'Create a new IPsec profile,' which is a specific verb and resource. It distinguishes from sibling operations like update, list, and delete for IPsec profiles, though not from other creation tools in the same domain.
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 vs alternatives such as sdcloud_update_ipsec_profile or sdcloud_delete_ipsec_profile. No prerequisites or context provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.