Skip to main content
Glama

Pair Display by Code

pair_by_code

Binds a screen the user is standing at: a TV, a wall panel, a kiosk, a tablet on the wall. Use it when they have that screen in front of them, since pairing binds the hardware permanently: ask them to open https://display.agentview.de on the device that should show the content and read you the 6-character code, then call this; profile_name is optional (pass it only if they named the place). Afterwards send content and show it with get_display_preview_url. When they have no screen yet and want to see something now, prefer create_display and hand them its managedUrl. Pairing needs mcp:display.setup (granted to connectors on connection). Pass target_display_id to rebind an EXISTING display onto new hardware (keeps name, settings, content); that needs full admin, which a connector session obtains without re-authorizing: run create_auth_session with scope 'admin', show the loginUrl, poll get_auth_session until active, then call this again with that session_request_id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeYesThe 6-character pairing code shown on the display (e.g. 'AB3K7F').
access_tokenNoOptional bearer token; prefer session_request_id.
profile_nameNoOptional name for a new display; pass it only if the user named the place, otherwise a default is assigned. Ignored for rebind. Example: 'Front counter'.
target_display_idNoTo rebind: the existing display profile ID to switch to the new hardware. Omit for new display pairing.
session_request_idNoSession handle from create_auth_session; pass it on every authenticated call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
profileIdNo
linkedHardwareIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / profile_name / description
      Previous value: -"Friendly name for the display (required for new pairing, ignored for rebind). Example: 'Lobby Screen'."New value: +"Optional name for a new display; pass it only if the user named the place, otherwise a default is assigned. Ignored for rebind. Example: 'Front counter'."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "linkedHardwareId": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "name": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "profileId": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "type": "object"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / session_request_id
      Added value: +{
      +  "description": "Session handle from create_auth_session; pass it on every authenticated call.",
      +  "type": "string"
      +}
  4. Changed2 schema fields changed
    • changedInput schema / properties / access_token / description
      Previous value: -"Optional JWT access token for authentication."New value: +"Optional bearer token; prefer session_request_id."
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "linkedHardwareId": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "mode": {
      -      "enum": [
      -        "new",
      -        "rebind"
      -      ],
      -      "type": "string"
      -    },
      -    "name": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "profileId": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    }
      -  },
      -  "type": "object"
      -}New value: +null
  5. Changed3 schema fields changed
    • changedOutput schema / properties / linkedHardwareId / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / name / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / profileId / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
  6. Changed8 schema fields changed
    • removedInput schema / properties / access_token / default
      Removed value: -null
    • changedInput schema / properties / access_token / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
    • changedInput schema / properties / code / description
      Previous value: -"The 6-character pairing code shown on the display (e.g. 'AB3K7F'). Characters are from the set 23456789ABCDEFGHJKLMNPQRSTUVWXYZ."New value: +"The 6-character pairing code shown on the display (e.g. 'AB3K7F')."
    • removedInput schema / properties / profile_name / default
      Removed value: -null
    • changedInput schema / properties / profile_name / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
    • removedInput schema / properties / target_display_id / default
      Removed value: -null
    • changedInput schema / properties / target_display_id / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "linkedHardwareId": {
      +      "type": "string"
      +    },
      +    "mode": {
      +      "enum": [
      +        "new",
      +        "rebind"
      +      ],
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "profileId": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  7. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare it is a non-read-only, non-idempotent, non-destructive write; the description adds the critical behavioral facts—pairing is permanent hardware binding, requires mcp:display.setup, and rebinding needs full admin obtained through a create_auth_session/admin flow with loginUrl and polling. This is far beyond what the annotations convey.

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?

Front-loaded with the core purpose, then consequences, alternatives, and the rebind sub-workflow. It is dense and lengthy, but nearly every sentence carries operational value (permissions, ordering, alternatives), so little is wasted.

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

Completeness5/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 not be explained. Given the multi-step auth/rebind complexity, the description covers permissions, prerequisites, the alternative tool, and the full admin escalation sequence—complete enough for correct invocation.

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

Parameters4/5

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

Schema coverage is 100% and already documents each parameter, but the description adds non-obvious semantics: profile_name is ignored during rebind, target_display_id switches an existing profile onto new hardware keeping name/settings/content, and session_request_id is the auth handle. These go beyond the field-level text.

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+resource ('binds a screen... by 6-character code') and enumerates the concrete device types it applies to (TV, wall panel, kiosk, tablet). It also distinguishes itself from siblings create_display and get_display_preview_url by naming them in context.

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?

Explicit when-to-use ('Use it when they have that screen in front of them'), an explicit alternative for the opposite scenario ('When they have no screen yet... prefer create_display'), and a distinct rebind path via target_display_id. Nothing is left to inference.

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