Nginx Proxy Manager MCP

Overview Schema Source Related Servers Discussions Admin

Update Stream

update_stream

Modify forwarding settings for an existing Nginx Proxy Manager stream by ID, changing incoming port, destination host/port, or TCP/UDP protocol. Preview changes with dry_run before applying.

Instructions

Update writable port, destination, or protocol fields on an existing stream by ID. Use this to edit forwarding; use enable_stream or disable_stream to change status only. NPM receives the merged writable fields, preserving omitted values. Returns the updated stream object with its forwarding settings. Set dry_run=True to preview the exact request without changing NPM.

Input Schema

TableJSON Schema

Name	Required	Description
`id`	Yes	ID of the stream, from the matching list tool.
`dry_run`	No	When True, return the exact request preview without changing NPM.
`incoming_port`	No	Public TCP/UDP port number accepted by this stream. For updates, omit to keep the current value.
`tcp_forwarding`	No	Whether this stream forwards TCP traffic. For updates, omit to keep the current value.
`udp_forwarding`	No	Whether this stream forwards UDP traffic. For updates, omit to keep the current value.
`forwarding_host`	No	Hostname or IP address receiving stream traffic. For updates, omit to keep the current value.
`forwarding_port`	No	Destination TCP/UDP port number. For updates, omit to keep the current value.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed7 schema fields changedv0.5.2Oct 16, 2026

addedInput schema / properties / dry_run / description

Added value: +"When True, return the exact request preview without changing NPM."

addedInput schema / properties / forwarding_host / description

Added value: +"Hostname or IP address receiving stream traffic. For updates, omit to keep the current value."

addedInput schema / properties / forwarding_port / description

Added value: +"Destination TCP/UDP port number. For updates, omit to keep the current value."

addedInput schema / properties / id / description

Added value: +"ID of the stream, from the matching list tool."

addedInput schema / properties / incoming_port / description

Added value: +"Public TCP/UDP port number accepted by this stream. For updates, omit to keep the current value."

addedInput schema / properties / tcp_forwarding / description

Added value: +"Whether this stream forwards TCP traffic. For updates, omit to keep the current value."

addedInput schema / properties / udp_forwarding / description

Added value: +"Whether this stream forwards UDP traffic. For updates, omit to keep the current value."

First observedv0.5.1Oct 16, 2026

TDQS

A4.4/5.0

Behavior4/5

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

With no annotations, the description carries the full burden and does meaningful work: it discloses patch/merge semantics (omitted writable fields are preserved, NPM receives the merged set), the dry_run preview behavior, and the return shape. It stops short of stating permission requirements, reversibility, or error behavior on invalid IDs.

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

Conciseness5/5

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

Four tight sentences, zero filler: scope and field list first, then routing to siblings, then merge behavior, then the dry_run affordance. Every sentence earns its place and the most decision-relevant information is front-loaded.

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

Completeness4/5

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

For a 7-parameter mutation tool with no annotations but a full schema and an output schema, the description covers scope, merge semantics, preview mode, and sibling routing, so an agent can call it correctly. The only real gap is operational context such as permissions or failure modes.

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 100%, so every parameter including dry_run is already documented in the schema, and the description's merge note largely restates the schema's 'omit to keep the current value'. It adds only the implicit constraint that some fields are non-writable. Baseline 3 is appropriate when the schema does the heavy lifting.

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

Purpose5/5

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

States a specific verb (update), resource (existing stream by ID) and the exact field families in scope (writable port, destination, protocol). It explicitly names enable_stream/disable_stream as the status-only siblings, so an agent can separate this from those without opening a schema.

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

Usage Guidelines5/5

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

Gives both the when ('edit forwarding') and the when-not with the alternative named ('use enable_stream or disable_stream to change status only'). It also adds a safe-preview route (dry_run=True) for agents that need to verify intent before mutating.

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