Skip to main content
Glama

put_vpn_client_config_id

Update VPN server configuration including type, enabled state, port, IP ranges, and protocol-specific options for PPTP, OpenVPN, or IPsec.

Instructions

Update the VPNServerConfig

Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
id__pathYes(Path parameter)
idNoVPN server id
typeNoVPN server type — Values: `pptp`: PPTP VPN server; `openvpn`: OpenVPN server; `ipsec`: IPsec IKEv2 server
enabledNois the VPN server enabled
enable_ipv4Noenable IPv4 on this server
enable_ipv6Noenable IPv4 on this server
portNothe server port
min_portNoThis field indicate the minimum possible value for port (see ConnectionStatus ipv4_port_range)
max_portNoThis field indicate the maximum possible value for port (see ConnectionStatus ipv4_port_range)
port_ikeNoIPSec ike server port
port_natNoIPSec nat server port
conf_pptpNoonly available when type is PPTP
conf_openvpnNoonly available when type is OpenVPN
conf_ipsecNoonly available when type is IPsec
ip_startNostart of the IP range that will be used to give clients an IP
ip_endNoend of the IP range that will be used to give clients an IP
ip6_startNostart of the IPv6 range that will be used to give clients an IPv6
ip6_endNoend of the IPv6 range that will be used to give clients an IPv6

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • changedInput schema / properties / id__path / type
      Previous value: -"integer"New value: +"string"
  2. Changed30 schema fields changed
    • removedInput schema / $defs
      Removed value: -{
      -  "VPNClientConfig": {
      -    "properties": {
      -      "active": {
      -        "description": "is this configuration active. Only one configuration is active at a time.",
      -        "type": "boolean"
      -      },
      -      "allowed_auth": {
      -        "description": "allowed authentication methods dictionnary with following keys:",
      -        "type": "object"
      -      },
      -      "conf_pptp": {
      -        "$ref": "#/$defs/VPNClientConfig",
      -        "description": "only available when type is PPTP"
      -      },
      -      "description": {
      -        "description": "VPN description",
      -        "type": "string"
      -      },
      -      "id": {
      -        "description": "VPN config id",
      -        "type": "string"
      -      },
      -      "mppe": {
      -        "description": "Values: `disable`: disable mppe; `require`: require mppe; `require_128`: require 128 bits mppe",
      -        "enum": [
      -          "disable",
      -          "require",
      -          "require_128"
      -        ],
      -        "type": "string"
      -      },
      -      "password": {
      -        "description": "VPN password",
      -        "type": "string"
      -      },
      -      "remote_host": {
      -        "description": "remote host IP or name",
      -        "type": "string"
      -      },
      -      "type": {
      -        "description": "VPN server type — Values: `pptp`: PPTP VPN server; `openvpn`: OpenVPN server",
      -        "enum": [
      -          "pptp",
      -          "openvpn"
      -        ],
      -        "type": "string"
      -      },
      -      "username": {
      -        "description": "VPN username",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -}
    • removedInput schema / properties / active
      Removed value: -{
      -  "description": "is this configuration active. Only one configuration is active at a time.",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / allowed_auth
      Removed value: -{
      -  "description": "allowed authentication methods dictionnary with following keys:",
      -  "type": "object"
      -}
    • addedInput schema / properties / conf_ipsec
      Added value: +{
      +  "description": "only available when type is IPsec",
      +  "properties": {
      +    "auth_modes": {
      +      "description": "map of supported auth modes, currently only psk is supported",
      +      "items": {
      +        "properties": {
      +          "id_custom": {
      +            "description": "value of the source id when id_source is custom",
      +            "type": "string"
      +          },
      +          "id_source": {
      +            "description": "source of the connection id",
      +            "enum": [
      +              "custom"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "ike_version": {
      +      "description": "IKE protocol version",
      +      "type": "integer"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / conf_openvpn
      Added value: +{
      +  "description": "only available when type is OpenVPN",
      +  "properties": {
      +    "cipher": {
      +      "enum": [
      +        "blowfish",
      +        "aes128",
      +        "aes256"
      +      ],
      +      "type": "string"
      +    },
      +    "disable_fragment": {
      +      "description": "disable fragment configuration option",
      +      "type": "boolean"
      +    },
      +    "use_tcp": {
      +      "description": "use TCP instead of UDP",
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedInput schema / properties / conf_pptp / $ref
      Removed value: -"#/$defs/VPNClientConfig"
    • addedInput schema / properties / conf_pptp / properties
      Added value: +{
      +  "allowed_auth": {
      +    "description": "allowed authentication methods dictionnary with following entries:",
      +    "type": "object"
      +  },
      +  "mppe": {
      +    "description": "Values: `disable`: disable mppe; `require`: require mppe; `require_128`: require 128 bits mppe",
      +    "enum": [
      +      "disable",
      +      "require",
      +      "require_128"
      +    ],
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / conf_pptp / type
      Added value: +"object"
    • removedInput schema / properties / description
      Removed value: -{
      -  "description": "VPN description",
      -  "type": "string"
      -}
    • addedInput schema / properties / enable_ipv4
      Added value: +{
      +  "description": "enable IPv4 on this server",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / enable_ipv6
      Added value: +{
      +  "description": "enable IPv4 on this server",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / enabled
      Added value: +{
      +  "description": "is the VPN server enabled",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / id / description
      Previous value: -"VPN config id"New value: +"VPN server id"
    • changedInput schema / properties / id__path / description
      Previous value: -"VPN client config id to update (Path parameter)"New value: +"(Path parameter)"
    • changedInput schema / properties / id__path / type
      Previous value: -"string"New value: +"integer"
    • addedInput schema / properties / ip6_end
      Added value: +{
      +  "description": "end of the IPv6 range that will be used to give clients an IPv6",
      +  "type": "string"
      +}
    • addedInput schema / properties / ip6_start
      Added value: +{
      +  "description": "start of the IPv6 range that will be used to give clients an IPv6",
      +  "type": "string"
      +}
    • addedInput schema / properties / ip_end
      Added value: +{
      +  "description": "end of the IP range that will be used to give clients an IP",
      +  "type": "string"
      +}
    • addedInput schema / properties / ip_start
      Added value: +{
      +  "description": "start of the IP range that will be used to give clients an IP",
      +  "type": "string"
      +}
    • addedInput schema / properties / max_port
      Added value: +{
      +  "description": "This field indicate the maximum possible value for port (see ConnectionStatus ipv4_port_range)",
      +  "type": "integer"
      +}
    • addedInput schema / properties / min_port
      Added value: +{
      +  "description": "This field indicate the minimum possible value for port (see ConnectionStatus ipv4_port_range)",
      +  "type": "integer"
      +}
    • removedInput schema / properties / mppe
      Removed value: -{
      -  "description": "Values: `disable`: disable mppe; `require`: require mppe; `require_128`: require 128 bits mppe",
      -  "enum": [
      -    "disable",
      -    "require",
      -    "require_128"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / password
      Removed value: -{
      -  "description": "VPN password",
      -  "type": "string"
      -}
    • addedInput schema / properties / port
      Added value: +{
      +  "description": "the server port",
      +  "type": "integer"
      +}
    • addedInput schema / properties / port_ike
      Added value: +{
      +  "description": "IPSec ike server port",
      +  "type": "integer"
      +}
    • addedInput schema / properties / port_nat
      Added value: +{
      +  "description": "IPSec nat server port",
      +  "type": "integer"
      +}
    • removedInput schema / properties / remote_host
      Removed value: -{
      -  "description": "remote host IP or name",
      -  "type": "string"
      -}
    • changedInput schema / properties / type / description
      Previous value: -"VPN server type — Values: `pptp`: PPTP VPN server; `openvpn`: OpenVPN server"New value: +"VPN server type — Values: `pptp`: PPTP VPN server; `openvpn`: OpenVPN server; `ipsec`: IPsec IKEv2 server"
    • changedInput schema / properties / type / enum
      Previous value: -[
      -  "pptp",
      -  "openvpn"
      -]New value: +[
      +  "pptp",
      +  "openvpn",
      +  "ipsec"
      +]
    • removedInput schema / properties / username
      Removed value: -{
      -  "description": "VPN username",
      -  "type": "string"
      -}
  3. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

The description lists numerous error codes, providing some insight into possible failure modes. However, with no annotations, it lacks disclosure on destructive behavior, authorization needs, or side effects.

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

Conciseness3/5

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

The description is brief but includes a long list of error codes, which is helpful but not succinct. The main action is front-loaded.

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?

Despite high schema coverage and an output schema, the description lacks explanation of return values, side effects, and tool behavior for a complex tool with 18 parameters. It feels incomplete.

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 coverage is 100%, so the description does not need to add parameter details. It adds no extra meaning beyond the schema, which is adequate but not enhanced.

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 clearly states 'Update the VPNServerConfig', indicating a specific verb and resource. However, it does not differentiate from sibling tools like put_vpn_openvpn_routed_config or post_vpn_client_config.

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?

No guidance is provided on when to use this tool versus alternatives. There is no mention of prerequisites, context, or exclusions.

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

Install Server

Other Tools