Skip to main content
Glama

update_wireguard_peer

Idempotent

Update an existing WireGuard peer's allowed addresses, endpoint, keepalive, or enabled state on MikroTik RouterOS to adjust VPN access.

Instructions

Updates an existing WireGuard peer's allowed addresses, endpoint, keepalive, or enabled state.

Notes: peer_id: "*N" or "N" from list output e.g. "*2" allowed_address: CIDR, comma-separated e.g. "10.0.0.2/32" or "10.0.0.0/24,192.168.0.0/24" persistent_keepalive: seconds as string e.g. "25" Pass "" for endpoint_address or preshared_key to clear them.

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": {
      "peer_id": "<peer_id>"
    },
    "name": "update_wireguard_peer"
  }
}

Input Schema

NameRequiredDescriptionDefault
deviceNo
commentNo
peer_idYes
disabledNo
endpoint_portNo
preshared_keyNo
allowed_addressNo
endpoint_addressNo
persistent_keepaliveNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.14.5
    • addedInput schema / properties / device
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Device"
      +}
  2. First observedv0.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare this a non-readOnly, non-destructive, idempotent mutation, so the safety bar is partly covered. The description adds real behavioral value beyond that: it discloses that passing an empty string to endpoint_address or preshared_key clears those fields, and it clarifies the accepted peer_id form from list output. It stops short of stating whether unspecified fields are left untouched (partial-update semantics).

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?

The action statement is front-loaded and the per-parameter notes are compact and scannable, with examples instead of prose. The only waste is minor: 'Notes:' block repeats parameter names that could be tied more directly to the schema fields.

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

Completeness3/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 no explanation, and clearing/format semantics are covered for the trickiest fields. However, four of nine parameters receive no description anywhere, and the partial-update behavior of an idempotent mutation tool is left implicit, which is a meaningful gap for a multi-field updater.

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

Parameters3/5

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

Schema description coverage is 0% across 9 parameters, so the description must compensate and only partly does. It gives concrete formats for peer_id ('*N' or 'N'), allowed_address (CIDR, comma-separated), persistent_keepalive (seconds as string), and clearing rules for endpoint_address/preshared_key, but says nothing about device, comment, disabled, or endpoint_port.

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 names a specific verb and resource ('Updates an existing WireGuard peer') and enumerates the affected fields: allowed addresses, endpoint, keepalive, enabled state. It is clearly distinguishable from add/remove/get peers, though it doesn't clarify its relationship to enable_wireguard_peer/disable_wireguard_peer, which overlap with the 'enabled state' it advertises.

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

Usage Guidelines3/5

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

'Existing' implies the peer must already be present, but there is no explicit when-to-use guidance, no mention of when to prefer enable_wireguard_peer/disable_wireguard_peer over the disabled flag, and no note about which operation to use to create versus modify. Usage is implied by the field list rather than stated.

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

Deploy Server

Other Tools