Skip to main content
Glama

Update Sharing Customizations

update_sharing_customizations
Destructive

Partially update a Wistia video's sharing customizations by changing only supplied fields; set a field to null to delete it and restore its default.

Instructions

Applies a partial update to a video's sharing customizations. Only the fields supplied are changed; sending a field as null deletes it (reverting to the default).

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token. Requires confirm=true for the requested mutation. May share access, notify people or incur provider charges.

Input Schema

NameRequiredDescriptionDefault
pluginNo
accountNoNamed private Wistia account; selects credentials, not a remote account ID.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON request body instead of body flags. Supports current nested customization, caption and nullable values.
media_idYesThe hashed ID of the video to be customized.
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.0
    • addedInput schema / $defs
      Added value: +{
      +  "plugin": {
      +    "properties": {
      +      "share": {
      +        "description": "Configuration for the share bar plugin.",
      +        "properties": {
      +          "channels": {
      +            "description": "Complete ordered list of share channels to enable on the share bar. This replaces the entire list — include every channel you want active. To enable downloads, include \"download\" here AND set downloadType.",
      +            "items": {
      +              "enum": [
      +                "embed",
      +                "email",
      +                "download",
      +                "facebook",
      +                "twitter",
      +                "linkedIn"
      +              ],
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "conversionOpportunityKey": {
      +            "description": "The key used for tracking conversion opportunities. Managed by Wistia when the share bar is enabled.",
      +            "type": "string"
      +          },
      +          "downloadType": {
      +            "description": "Which download quality is offered to viewers. Only takes effect when \"download\" is included in the channels array.",
      +            "enum": [
      +              "sd_mp4",
      +              "hd_mp4",
      +              "original",
      +              "all_qualities"
      +            ],
      +            "type": "string"
      +          },
      +          "on": {
      +            "description": "Whether the share bar is enabled.",
      +            "type": "boolean"
      +          },
      +          "overrideUrl": {
      +            "description": "URL used in place of the default share URL.",
      +            "type": "string"
      +          },
      +          "pageTitle": {
      +            "description": "Title of the page the share bar should reference.",
      +            "type": "string"
      +          },
      +          "pageUrl": {
      +            "description": "URL of the page the share bar should reference.",
      +            "type": "string"
      +          },
      +          "tweetText": {
      +            "description": "Default text used when sharing the video to X/Twitter.",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object",
      +        "unevaluatedProperties": false
      +      }
      +    },
      +    "type": "object",
      +    "unevaluatedProperties": false
      +  }
      +}
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for the specific user-requested write."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / payload / properties / plugin / $ref
      Added value: +"#/$defs/plugin"
    • removedInput schema / properties / payload / properties / plugin / properties
      Removed value: -{
      -  "share": {
      -    "description": "Configuration for the share bar plugin.",
      -    "properties": {
      -      "channels": {
      -        "description": "Complete ordered list of share channels to enable on the share bar. This replaces the entire list — include every channel you want active. To enable downloads, include \"download\" here AND set downloadType.",
      -        "items": {
      -          "enum": [
      -            "embed",
      -            "email",
      -            "download",
      -            "facebook",
      -            "twitter",
      -            "linkedIn"
      -          ],
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "conversionOpportunityKey": {
      -        "description": "The key used for tracking conversion opportunities. Managed by Wistia when the share bar is enabled.",
      -        "type": "string"
      -      },
      -      "downloadType": {
      -        "description": "Which download quality is offered to viewers. Only takes effect when \"download\" is included in the channels array.",
      -        "enum": [
      -          "sd_mp4",
      -          "hd_mp4",
      -          "original",
      -          "all_qualities"
      -        ],
      -        "type": "string"
      -      },
      -      "on": {
      -        "description": "Whether the share bar is enabled.",
      -        "type": "boolean"
      -      },
      -      "overrideUrl": {
      -        "description": "URL used in place of the default share URL.",
      -        "type": "string"
      -      },
      -      "pageTitle": {
      -        "description": "Title of the page the share bar should reference.",
      -        "type": "string"
      -      },
      -      "pageUrl": {
      -        "description": "URL of the page the share bar should reference.",
      -        "type": "string"
      -      },
      -      "tweetText": {
      -        "description": "Default text used when sharing the video to X/Twitter.",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object",
      -    "unevaluatedProperties": false
      -  }
      -}
    • removedInput schema / properties / payload / properties / plugin / type
      Removed value: -"object"
    • removedInput schema / properties / payload / properties / plugin / unevaluatedProperties
      Removed value: -false
    • addedInput schema / properties / plugin / $ref
      Added value: +"#/$defs/plugin"
    • removedInput schema / properties / plugin / properties
      Removed value: -{
      -  "share": {
      -    "description": "Configuration for the share bar plugin.",
      -    "properties": {
      -      "channels": {
      -        "description": "Complete ordered list of share channels to enable on the share bar. This replaces the entire list — include every channel you want active. To enable downloads, include \"download\" here AND set downloadType.",
      -        "items": {
      -          "enum": [
      -            "embed",
      -            "email",
      -            "download",
      -            "facebook",
      -            "twitter",
      -            "linkedIn"
      -          ],
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "conversionOpportunityKey": {
      -        "description": "The key used for tracking conversion opportunities. Managed by Wistia when the share bar is enabled.",
      -        "type": "string"
      -      },
      -      "downloadType": {
      -        "description": "Which download quality is offered to viewers. Only takes effect when \"download\" is included in the channels array.",
      -        "enum": [
      -          "sd_mp4",
      -          "hd_mp4",
      -          "original",
      -          "all_qualities"
      -        ],
      -        "type": "string"
      -      },
      -      "on": {
      -        "description": "Whether the share bar is enabled.",
      -        "type": "boolean"
      -      },
      -      "overrideUrl": {
      -        "description": "URL used in place of the default share URL.",
      -        "type": "string"
      -      },
      -      "pageTitle": {
      -        "description": "Title of the page the share bar should reference.",
      -        "type": "string"
      -      },
      -      "pageUrl": {
      -        "description": "URL of the page the share bar should reference.",
      -        "type": "string"
      -      },
      -      "tweetText": {
      -        "description": "Default text used when sharing the video to X/Twitter.",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object",
      -    "unevaluatedProperties": false
      -  }
      -}
    • removedInput schema / properties / plugin / type
      Removed value: -"object"
    • removedInput schema / properties / plugin / unevaluatedProperties
      Removed value: -false
  2. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, openWorldHint=true, idempotentHint=false, so the safety profile is partly carried. The description adds real value beyond that: the null-deletes-field rule, the permission scope requirements, confirm=true, and the 'may share access, notify people or incur provider charges' note. This is genuine behavioral context not present in annotations.

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

Conciseness3/5

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

Front-loads the core partial-update behavior effectively, but the permission block is verbose and repeats scope information already in the auth/permission system, and the note about sharing/notifying/charges is appended without clear structure.

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 destructive, nested, partially-documented mutation tool with no output schema, the description covers the mutation semantics, auth scope, confirmation requirement, and side-effect risks. It is largely complete, though it could more clearly route the agent among related update tools.

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 coverage is 83%, so most parameters are already documented in the schema, including the nuanced channels replacement behavior and downloadType coupling. The description adds the partial-update/null semantics for fields generally, which is useful, but does not add syntax or format detail beyond the schema, so baseline 3 is appropriate.

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+resource ('applies a partial update to a video's sharing customizations') and immediately clarifies the partial-update semantics and null-deletion behavior. It does not explicitly name or contrast with sibling read tools like get_sharing_customizations, so it falls short of 5.

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

Usage Guidelines3/5

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

The description implies usage through the partial-update and null-deletion rules, and notes the confirm=true requirement, but gives no explicit when-to-use vs alternatives (e.g., update_customizations, update_share_link). Guidance is implied rather than stated.

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