Skip to main content
Glama

Look up a branded link

get_branded_link
Read-onlyIdempotent

Shows what a branded page (…/r/) currently says: name, description, colour, video, whether it has a logo or background, and whether people are in its room right now. Use it before changing a page or to check a slug the user mentions. Read-only; needs no key.

Input Schema

NameRequiredDescriptionDefault
slugYesThe slug after /r/, or the whole public link.

Output Schema

NameRequiredDescriptionDefault
okYesfalse when the call failed; then code says why.
codeNoError code when ok is false.
liveNoSomeone is in the room now.
nameNoName.
slugNoSlug.
colorNo#rrggbb.
taglineNoOne-line description.
has_logoNo
video_urlNoVideo the room opens with, if any.
public_linkNoPublic link.
has_backgroundNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the 'Read-only' clause is largely redundant, but 'needs no key' adds an auth requirement not present in structured data. The description also discloses that the response includes live room-presence data, which is a dynamic behavioral trait an agent should know about before calling.

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?

Two sentences, front-loaded with what is returned, then the usage rule. No filler, no restatement of the title.

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?

With a rich output schema, full annotation coverage and one documented parameter, the description covers purpose, usage and auth adequately. It does not mention behavior for an unknown or invalid slug, which is the only notable omission.

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% for the single slug parameter, so the schema carries the weight and the baseline would be 3. The description adds marginal meaning by showing the …/r/<slug> URL form, which corroborates the schema's note that either the slug or the whole public link is accepted.

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 gives a specific verb (shows/reads) and resource (a branded page at …/r/<slug>) and enumerates exactly what is retrieved: name, description, colour, video, logo/background flags, and live room presence. This clearly separates it from create_branded_link, update_branded_link and delete_branded_link.

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 states two concrete usage contexts: 'before changing a page' and 'to check a slug the user mentions.' That is a clear when-to-use signal, though it stops short of naming an explicit alternative (e.g. get_watch_party) or a when-not-to-use condition.

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