Skip to main content
Glama

Create a branded watch-together link

create_branded_link

Creates a permanent public page (…/r/) with a name, an optional one-line description, colour and video. Everyone who opens it lands in that page's room, any time, so it suits teachers, classes, clubs and communities who reuse one link every week (for a one-off, use create_watch_room). Returns public_link to share and a private edit_link: the user opens it to add a logo and background and download a poster with a QR code, and it is needed for update_branded_link and delete_branded_link. Give edit_link only to the user, never to guests.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "create_branded_link"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName shown on the page, e.g. "Ms. Lee's English Class".
slugNoOptional. The link ending: 3-30 lowercase Latin letters, digits and hyphens (e.g. lee-english). Made from the name if omitted.
colorNoOptional theme colour as #rrggbb.
taglineNoOptional one line, e.g. "Every Tuesday at 8 pm".
video_urlNoOptional video to load in the room. A direct video link (mp4, webm, m3u8) or a public YouTube video URL. Paid streaming services are not supported.

Output Schema

NameRequiredDescriptionDefault
okYesfalse when the call failed; then code says why.
codeNoError code when ok is false.
slugNoThe link ending.
edit_linkNoPrivate edit link.
public_linkNoLink to share.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / video_url / description
      Previous value: -"Optional video to load in the room: a direct video link or a public YouTube video."New value: +"Optional video to load in the room. A direct video link (mp4, webm, m3u8) or a public YouTube video URL. Paid streaming services are not supported."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "code": {
      +      "description": "Error code when ok is false.",
      +      "type": "string"
      +    },
      +    "edit_link": {
      +      "description": "Private edit link.",
      +      "type": "string"
      +    },
      +    "ok": {
      +      "description": "false when the call failed; then code says why.",
      +      "type": "boolean"
      +    },
      +    "public_link": {
      +      "description": "Link to share.",
      +      "type": "string"
      +    },
      +    "slug": {
      +      "description": "The link ending.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "ok"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, openWorldHint=true, destructiveHint=false) it discloses that the page is permanent and publicly reachable, that all visitors land in the same room, and a real security constraint: give edit_link only to the user, never to guests. It does not address slug collisions or what happens when a slug is already taken, which is the main remaining behavioral gap for a non-idempotent creator.

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 effect and URL shape, then rationale, then the return-value and sharing rules. Dense and largely waste-free, though the opening sentence runs long and chains several clauses.

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 public, open-world creator with an output schema, the description covers what is created, who it is for, the alternative tool, and the two key outputs plus the sharing caveat on edit_link. Nothing an agent needs in order to call it safely is missing.

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 all five parameters are already documented with examples and constraints. The description only gestures at the field set ('a name, an optional one-line description, colour and video') and the slug's role in the URL, adding little meaning beyond the schema.

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 and resource ('Creates a permanent public page (…/r/<slug>)') and enumerates the configurable facets: name, description, colour and video. It also explicitly contrasts with the sibling create_watch_room for one-off use, so an agent can distinguish it without opening any schema.

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?

Gives a concrete when-to-use profile ('suits teachers, classes, clubs and communities who reuse one link every week') and an explicit alternative for the opposite case ('for a one-off, use create_watch_room'). It also names the downstream tools that require the returned edit_link, which routes the agent through the correct lifecycle.

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