UGC Agent

Get UGC Brand

get_ugc_brand

Read-onlyIdempotent

One brand's UGC program, by app tab. view=overview (default, Pro or higher): how the program runs, creator pay (program.pay_per_video_usd is the guaranteed rate; program.pay adds the pay model, min/max with bonuses, a one-line summary and the sources with the quote stating the pay and when it was checked; cite those when quoting a rate), sources, full KPIs and top creator accounts; the range block holds the Overview for a date window (window 7d/30d/90d/365d/all, or from/to dates; default last 30 days). view=videos (Premium or higher): the program's videos sorted by views, outliers or newest, with captions, metrics and links. view=playbook (Premium or higher): what works, reused caption hooks, hashtags, video vs slideshow, best length, virality spread and account naming patterns; use it to brief creators on a proven program. Free.

Input Schema

Name	Required	Description
`to`	No	overview only: custom range end, YYYY-MM-DD inclusive (UTC). Defaults to today.
`uid`	No	Optional Firebase uid. Must match the URL uid unless local fallback is enabled.
`from`	No	overview only: custom range start, YYYY-MM-DD (UTC). Use instead of window.
`sort`	No	videos only.
`view`	No
`limit`	No	Page size, 1-100 (default 25).
`cursor`	No	The next_cursor from the previous page. Keep the other filters identical.
`window`	No	overview: rolling date window for `range` (default 30d). videos and playbook: 30d (default) or all only.
`brand_id`	Yes	Brand id from list_ugc_brands.
`platforms`	No	videos only.
`bearer_token`	No	Optional Firebase ID token. Hosted clients normally authenticate with an API key header or ?uid= in the URL instead.

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedOct 31, 2026

addedInput schema / properties / from

Added value: +{
+  "description": "overview only: custom range start, YYYY-MM-DD (UTC). Use instead of window.",
+  "pattern": "^\\d{4}-\\d{2}-\\d{2}",
+  "type": "string"
+}

addedInput schema / properties / to

Added value: +{
+  "description": "overview only: custom range end, YYYY-MM-DD inclusive (UTC). Defaults to today.",
+  "pattern": "^\\d{4}-\\d{2}-\\d{2}",
+  "type": "string"
+}

changedInput schema / properties / window / description

Previous value: -"videos and playbook: last 30 days (default) or all time."New value: +"overview: rolling date window for `range` (default 30d). videos and playbook: 30d (default) or all only."

changedInput schema / properties / window / enum

Previous value: -[
-  "30d",
-  "all"
-]New value: +[
+  "7d",
+  "30d",
+  "90d",
+  "365d",
+  "all"
+]

First observedOct 31, 2026

TDQS

A4.1/5.0

Behavior3/5

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

Annotations already declare readOnly/idempotent/non-destructive, so safety is covered. The description adds genuine context: tier gating, default 30-day window, and provenance discipline ('cite those when quoting a rate' / sources with quote and check date). However, it doesn't cover pagination behavior or error/permission failure modes, so it sits at a solid but not rich 3.

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 resource statement, then organized by view mode. Dense but each clause carries information (pay model details, tier gates, defaults). The long run-on sentences for pay/overview slightly hurt scannability.

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 11 params, no output schema, and annotations covering safety, the description does the heavy lifting of explaining what each view returns and the tier prerequisites. Remaining gap: it doesn't detail the pagination/cursor contract even though a cursor param exists, but schema covers it adequately.

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 91%, so baseline is 3. The description goes beyond by explaining the view enum semantics (which are undocumented in the schema), window options and defaults ('window 7d/30d/90d/365d/all, or from/to dates; default last 30 days'), and the range block behavior — meaningful additions to the structured fields.

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 resource (one brand's UGC program) and verb (retrieval), then enumerates three distinct view modes with their contents. An agent can tell exactly what it gets and how it differs from list_ugc_brands or list_ugc_brand_creators.

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?

Per-view guidance is explicit: overview for how the program runs and pay, videos for sorted video data, playbook 'to brief creators on a proven program.' Tier availability (Free/Pro/Premium) is also stated. It lacks explicit when-not-to-use or naming of sibling alternatives, so not a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All UGC Agent tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?