Skip to main content
Glama

Cluby MCP

by com.cluby.api
OverviewDiscussionsAdmin

Update smart link

update_smart_link
DestructiveIdempotent

Edit a smart link (smartLinkId is the id from list_smart_links). Only the fields sent change. Requires the admin role. action is what the link does when scanned: join (member joins the venue; target venue::<venueId>), show (opens the venue or a benefit; target venue::<venueId> or org::<orgId>::venue::<venueId>::benefit::<benefitId>), stamp (gives a stamp; target org::<orgId>::venue::<venueId>::stampcard::<stampCardId>), redirect (target an https URL) or none (target null). Every scan of a link whose target names a venue emits a smart_link.scanned event to each of the organization's endpoints subscribed to it. webhook: { endpointId, ref } additionally ties the tag to one endpoint (its id from list_webhook_endpoints or get_pos_connection's endpoint.id; create_webhook_endpoint / set_pos_connection first): ref is that receiver's own reference for the tag, such as a cash register id, echoed to it as posRef. webhook: null drops the tie. smartCardPublicId (a card's publicId from list_nfc_cards) attaches that NFC card to the link so a tap opens it. A card already attached to another link is refused (409): first detach it with update_smart_link on that link, smartCardPublicId: null, which detaches every card from it.

Input Schema

NameRequiredDescriptionDefault
bodyYes
orgIdNoOrganization public id, the `id` field from list_orgs. Omit it when the API key reaches exactly one organization.
smartLinkIdYesSmart link `id` from list_smart_links

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedInput schema / properties / body / properties / action / description
      Added value: +"What a scan does: `join` the venue, `show` it, `stamp` a stamp card, `redirect` to a URL, or `none`."
    • addedInput schema / properties / body / properties / enabled / description
      Added value: +"`false` turns the tag off."
    • addedInput schema / properties / body / properties / name / description
      Added value: +"A label, such as `Till K-1`."
    • addedInput schema / properties / body / properties / smartCardPublicId / description
      Added value: +"Attach the NFC card with this printed id, such as `00AE`; `null` detaches the tag's card. A card is on one tag at a time."
    • addedInput schema / properties / body / properties / target / description
      Added value: +"What the action acts on: `venue::{venueId}` for `join` and `show`, `stampcard::{stampCardId}` for `stamp`, an https URL for `redirect`, `null` for `none`. A register tag targets its venue."
    • changedInput schema / properties / body / properties / webhook / anyOf
      Previous value: -[
-  {
-    "properties": {
-      "endpointId": {
-        "maxLength": 16,
-        "minLength": 1,
-        "type": "string"
-      },
-      "ref": {
-        "anyOf": [
-          {
-            "maxLength": 100,
-            "minLength": 1,
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "default": null
-      }
-    },
-    "required": [
-      "endpointId"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "properties": {
+      "endpointId": {
+        "description": "The webhook endpoint the tag is tied to: the POS connection's `endpoint.id`.",
+        "maxLength": 16,
+        "minLength": 1,
+        "type": "string"
+      },
+      "ref": {
+        "anyOf": [
+          {
+            "maxLength": 100,
+            "minLength": 1,
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "default": null,
+        "description": "Your till reference, sent back as `posRef` on every scan. Unique per endpoint: a duplicate answers 409."
+      }
+    },
+    "required": [
+      "endpointId"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • addedInput schema / properties / body / properties / webhook / description
      Added value: +"Ties the tag to your endpoint, so its scans carry `posRef` and the action links. `null` removes the tie. The target must be a venue."
  2. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare idempotent and destructive behavior, and the description adds substantial beyond that: partial-update semantics, admin-role requirement, smart_link.scanned event emission, webhook tie behavior with posRef echo, 409 conflict handling for cards already attached, and detach remediation. Nothing here contradicts the annotations.

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?

The core edit semantics and admin requirement are front-loaded before the detailed action and webhook rules. It is dense and long, but most of the length earns its place given the complexity of action targets, webhook ties, and NFC card conflicts.

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?

For a complex, destructive, idempotent update tool with nested parameters and no output schema, the description covers prerequisites, partial-update behavior, action semantics, webhook tie lifecycle, and conflict remediation. An agent has enough information to invoke it correctly.

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?

The schema already describes most properties, and the description adds valuable meaning for action/target pairings, webhook endpoint ties, ref echo behavior, and smartCardPublicId attach/detach. Some details, such as name/slug/expiresAt, are left mostly to the schema, and the target format for stamp/show is described slightly differently from the schema, so it is not fully exemplary.

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?

The description opens with a specific verb and resource ('Edit a smart link') and immediately clarifies partial-update semantics ('Only the fields sent change') plus the required admin role. It clearly distinguishes this from create_smart_link and other sibling mutations.

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

Usage Guidelines4/5

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

It gives clear operational context: admin role required, smartLinkId comes from list_smart_links, webhook endpointId must be created or found first, and cards come from list_nfc_cards. It does not explicitly say when not to use it versus create_smart_link, but for an update tool that is largely implied.

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

All Cluby MCP toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources