add_pattern

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

No annotations provided, so description must carry full burden. States 'Add' but does not disclose side effects, uniqueness of pattern_id, or that it modifies the currently loaded network. Minimal behavioral context.

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 short and includes a docstring-style argument list. No unnecessary words. However, the structure could be improved by front-loading the main sentence before the args.

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?

Despite having an output schema, the description omits important context: that the network must be loaded first, that pattern_id must be unique, and that it modifies the in-memory network. Incomplete for a mutation 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 coverage is 0%, but description adds basic explanations for each parameter: network_id as 'Session id', pattern_id as 'Unique name', values as 'Multiplier values'. This is adequate but still minimal; could include value range or format.

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 'Add a new demand / operational pattern to the network.' Identifies action (add), resource (pattern), and context (network). Distinguishes from siblings like set_pattern (modify) and get_patterns (list).

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 explicit guidance on when to use this tool vs alternatives. Does not mention prerequisites (e.g., network must be loaded) or conditions for use. Implied usage from description, but no exclusions or alternatives listed.

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