Skip to main content
Glama

Build a Wi-Fi QR

qr_build_wifi
Read-onlyIdempotent

Encode Wi-Fi credentials (SSID, password, auth type, hidden flag) into a scannable Wi-Fi QR. Returns both the WIFI:... payload string and a generated QR image.

Input Schema

NameRequiredDescriptionDefault
ssidYesThe Wi-Fi network name (SSID).
hiddenNoSet true if the SSID is hidden (not broadcast). Defaults to false.
authTypeNoAuthentication type. Defaults to "WPA". Use "nopass" for open networks.
passwordNoNetwork password. Required unless authType is "nopass".

Output Schema

NameRequiredDescriptionDefault
formatYesFile format the engine rendered: png, svg, jpg, webp or pdf.
payloadYesThe payload string the engine built and the QR encodes (WIFI:..., BEGIN:VCARD..., geo:...).
filePathNoPDF in the stdio package only: local temp file the PDF was written to.
mimeTypeNoMIME type of the rendered file (the engine's contentType).
sizeBytesNoSize of the rendered file in bytes, as reported by the engine.
resourceUriNoPDF on the remote server only: URI of the embedded resource block that carries the file.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "filePath": {
      +      "description": "PDF in the stdio package only: local temp file the PDF was written to.",
      +      "type": "string"
      +    },
      +    "format": {
      +      "description": "File format the engine rendered: png, svg, jpg, webp or pdf.",
      +      "type": "string"
      +    },
      +    "mimeType": {
      +      "description": "MIME type of the rendered file (the engine's contentType).",
      +      "type": "string"
      +    },
      +    "payload": {
      +      "description": "The payload string the engine built and the QR encodes (WIFI:..., BEGIN:VCARD..., geo:...).",
      +      "type": "string"
      +    },
      +    "resourceUri": {
      +      "description": "PDF on the remote server only: URI of the embedded resource block that carries the file.",
      +      "type": "string"
      +    },
      +    "sizeBytes": {
      +      "description": "Size of the rendered file in bytes, as reported by the engine.",
      +      "maximum": 9007199254740991,
      +      "minimum": 0,
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "format",
      +    "payload"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered structurally. The description adds the output content ('WIFI:... payload string and a generated QR image'), which is modest added value since an output schema also exists, but it says nothing about limits or failure cases (e.g. missing password when authType is not nopass).

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?

Two tight sentences, zero filler, with the action and resource front-loaded before the return description. Every clause earns its place.

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?

With a full schema, an output schema, and complete annotations, the description covers what is needed to invoke the tool correctly. The remaining gap is routing information (when to pick this over a generic QR generator), which belongs to usage guidance rather than completeness of the definition itself.

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 is already documented in the schema, including the authType enum and the password-required-unless-nopass rule. The description only restates the parameter names in a parenthetical, adding no syntax or default detail beyond the schema; baseline 3 applies.

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 ('Encode') and a precise resource (Wi-Fi credentials) with the fields enumerated, so an agent immediately knows this is the Wi-Fi-specific builder. It does not explicitly contrast itself with qr_build_geo/qr_build_vcard/qr_generate, though the resource name makes the distinction largely self-evident.

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 when-to-use guidance and no mention of alternatives among the six sibling tools. The only hint is the implicit purpose of encoding Wi-Fi credentials, which is the minimal information an agent could infer from the name alone.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources