create_pattern

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

With no annotations, the description must disclose behavioral traits. It explains that IGNORE deletes matching streams and describes the meaning of search_type and direction_type. However, it does not mention whether the tool is idempotent, what happens if a pattern with the same name already exists, or any authorization requirements.

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 concise, using a short paragraph and inline explanations for each enum. It is front-loaded with purpose and then parameter details. However, a bulleted list could improve readability and scannability.

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?

While the output schema exists (not shown), the description omits important context such as the purpose of name/value, potential errors, and how this tool fits into the broader workflow (e.g., after creating a service). It is adequate for a straightforward create operation but not fully 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 description adds meaning for action_type, search_type, direction_type, and service_port, which are 4 of 7 parameters. The required parameters name and value are left entirely unexplained, and color is also absent. Given the schema coverage signal of 0%, this is a partial but valuable addition.

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 pattern and explains the key parameters that define the pattern behavior. However, it does not distinguish this from similar tools like update_pattern, which could cause confusion about when to create versus update.

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 its siblings (e.g., update_pattern, set_pattern_enabled). There is no mention of prerequisites, conflicts, or typical use cases, making it hard for an agent to decide appropriately.

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