Skip to main content
Glama

openwisp_patch_device_connection

Partially update an OpenWISP device connection using device and connection IDs, modifying only specified connection fields via PATCH.

Instructions

[Category: Devices & Controller] Partially update a device connection. (HTTP PATCH /api/v1/controller/device/{device_id}/connection/{connection_id}/)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
device_idYesDevice UUID or ID
connection_idYesConnection UUID or ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. 'Partially update' implies PATCH semantics (only supplied fields change), which is useful, but it says nothing about auth requirements, reversibility, side effects on live connections, or what the response contains.

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 tight sentence with the endpoint appended; front-loaded and free of filler. Slightly under-specified rather than bloated.

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?

For a mutation tool with no annotations and no output schema, an agent still cannot tell which connection attributes can be patched or how to supply them, since the schema exposes only device_id and connection_id. The description does not fill this void.

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% for the two required identifiers, so the schema already documents them fully and the description adds nothing. Baseline 3 applies. Notably, no body/patchable-field parameters appear in the schema, and the description does not address that gap.

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?

States a specific verb and resource ('Partially update a device connection') and includes the underlying HTTP method and endpoint, which distinguishes it from the full-update sibling openwisp_update_device_connection. The category tag adds orientation but no sibling routing.

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 on when to use partial PATCH versus openwisp_update_device_connection, no prerequisites, and no exclusions. The only implicit signal is the word 'partially', which the agent must infer.

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