Skip to main content
Glama

Change a branded link

update_branded_link
DestructiveIdempotent

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.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

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?

Beyond the mutation, idempotency, and destructiveness annotations, it explains partial-update behavior, private-credential requirements, and that omitted fields and the slug remain stable. The assurance that posters and shared links keep working, plus the explicit video-removal behavior, gives agents practical safety and side-effect context.

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 editable fields and purpose are front-loaded, followed by invocation requirements, stability guarantees, removal syntax, and scope exclusions in a logical order. All five sentences convey distinct, actionable information without filler.

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?

Together with the fully described schema and annotations, the description supplies everything needed to select and invoke this moderately complex update correctly, including authentication, partial updates, immutable identity, and unsupported changes. The output schema means no additional return-value explanation is necessary.

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 several details such as the credential alternatives and empty video_url convention repeat schema descriptions. The description still adds useful cross-parameter semantics by explaining sparse updates, emphasizing that edit_link is private, and clarifying that slug identifies an immutable public link rather than an editable field.

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 identifies the exact operation and resource: changing the name, description, colour, or video of a branded page created with create_branded_link. It also narrows scope by stating that the slug is unchanged and that logo and background changes belong on the edit page, clearly distinguishing this tool from creation and other sibling operations.

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 concrete invocation guidance: pass only fields being changed, supply either the private edit_link or slug plus edit_key, and use an empty video_url to remove the video. The explicit exclusion—"Logo and background are changed on the edit page, not here"—provides useful when-not guidance and an alternative.

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