Skip to main content
Glama

set_pattern_timestep

Sets the demand and quality-source pattern timestep, in seconds, for a specified EPANET network to control pattern timing in simulations.

Instructions

Set the demand and quality-source pattern timestep in seconds.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "network_id": "<network_id>",
      "timestep_s": "<timestep_s>"
    },
    "name": "set_pattern_timestep"
  }
}

Input Schema

NameRequiredDescriptionDefault
network_idYes
timestep_sYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.0

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations, the description carries the full burden, and it only supplies the unit ('in seconds'). It does not disclose whether this is a network-wide mutation, whether existing pattern data is resampled or lost, what permissions or model state are required, or whether the change is reversible.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler, and the key scope ('pattern') appears early. The terseness is efficient but borders on under-specification rather than true conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained, but for a two-parameter mutation tool with zero annotation coverage and zero schema parameter descriptions, the definition leaves too much unstated: preconditions, scope of effect, and parameter meaning are all missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so neither network_id nor timestep_s is documented in the schema. The description only clarifies that the timestep is expressed in seconds; it says nothing about what network_id refers to (an existing network name or ID) or any constraints on timestep_s values.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb ('Set') and a specific resource ('demand and quality-source pattern timestep'), so the agent knows this configures a pattern time resolution rather than a hydraulic or quality timestep. It stops short of explicitly naming the sibling tools it differs from (set_hydraulic_timestep, set_quality_timestep), leaving the distinction to be inferred from the word 'pattern'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when this should be used versus set_hydraulic_timestep or set_quality_timestep, nor any precondition such as whether the simulation must be stopped or whether patterns must already exist. The agent must infer selection purely from the name.

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