Create a URL pattern object by providing name, description, and address_patterns to define reusable URL sets for firewall and security policy enforcement.
Create a new URL pattern object. Body typically includes name, description, address_patterns.
| 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?
With no annotations, the description must disclose behavioral traits. It only states 'create,' implying a write operation, but lacks details on permissions, idempotency, side effects, or error conditions. Minimal beyond the function name.
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 short sentences, front-loading the purpose and providing a useful parameter hint. Every sentence contributes meaning with no wasted text.
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 creation tool with no output schema, the description covers the basic action and typical body fields but omits return value details, required sub-fields, and links to related CRUD tools. Adequate but could be more complete.
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 schema for the single parameter 'body' is generic (matches SD Cloud schema) with no sub-fields defined. The description adds value by listing typical fields (name, description, address_patterns), helping the agent understand what to include.
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 'Create a new URL pattern object,' identifying the action and resource. It distinguishes from sibling tools like list, get, update, and delete by specifying creation. The hint about typical body fields adds further clarity.
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 is provided on when to use this tool versus alternatives or on prerequisites. It does not mention any conditions or exclusions, leaving the agent without context for appropriate usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.