Skip to main content
Glama

Change a branded link

update_branded_link
Idempotent

Changes the name, description, colour or video of a branded page made with create_branded_link. Pass only the fields to change; the link itself (slug) stays the same, so posters and shared links keep working. Needs the private edit_link (or slug and edit_key). Pass video_url as an empty string to remove the video. Logo and background are changed on the edit page, not here.

Input Schema

NameRequiredDescriptionDefault
nameNoNew name.
slugNoThe page's slug (the part after /r/). Needed with edit_key when edit_link is not given.
colorNoNew theme colour as #rrggbb.
taglineNoNew one-line description; empty string removes it.
edit_keyNoThe key after #k= in the edit link.
edit_linkNoThe private edit link returned by create_branded_link (…/r/<slug>/edit#k=<key>). Alternatively pass slug and edit_key.
video_urlNoNew video, or empty string for none. 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.
slugNoSlug.
public_linkNoPublic link (unchanged).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare this is a non-readonly but idempotent and non-destructive mutation. The description adds important behavioral context beyond annotations: authentication requirements, partial-update semantics, slug immutability so shared links keep working, and video removal behavior.

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?

The description is front-loaded with the core purpose, then adds only operationally useful constraints in compact sentences. There is little waste, and the exclusion about logo/background is clearly separated.

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 7-parameter update tool with full schema coverage, annotations, and an output schema, the description covers the missing behavioral and usage context an agent needs. It explains authentication, partial updates, slug stability, removal semantics, and what is out of scope.

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 description coverage is 100%, so the schema already documents each parameter well. The description still adds useful semantics beyond the schema by explaining partial updates, the relationship between edit_link and slug/edit_key, and the consequences of changing video_url to an empty string.

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 states a specific verb and resource: it changes a branded page's name, description, colour, or video, and ties it to create_branded_link. It also clarifies that the slug stays the same, which distinguishes an update from link creation or deletion.

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?

It gives explicit usage rules: pass only fields to change, supply edit_link or slug plus edit_key, use an empty string to remove video, and change logo/background on the edit page rather than here. These are concrete when-to-use, prerequisite, and exclusion conditions.

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