Skip to main content
Glama

Captapi

by io.github.CDCStream
OverviewDiscussionsAdmin

tiktok_ad_library_top_ads

TikTok Creative Center Top Ads — one ~20-row leaderboard page, not a library search (flat 2; ~1/ad on the fallback path). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).

Input Schema

NameRequiredDescriptionDefault
qNoOptional keyword that ranks the one ~20-row leaderboard page — not a library search. Case-insensitive whole-word hits on title/brandName/industry/objective (hair ≠ wheelchair) come first; the rest of TikTok's keyword-ranked page follows as fill (matchedFrom [] on those ads, rankedFill in the envelope). There is no tags field. advertiser.name is often null in the default US market. Envelope candidatesScanned is the pre-filter pool size. For a known advertiser, use /tiktok/ad-details by ad id.
cacheNoSet true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh.
limitNoMax items to return (default 20, max 20). One Creative Center leaderboard page is ~20 rows; limit only trims that pool — it cannot scan more candidates. Flat 2 credits on the native path; the fallback path ~1 credit per returned ad (min 2).
matchNoKeyword token mode: "any" (default, OR) or "all" (AND). Zero whole-word hits still return TikTok's keyword-ranked page as matchBasis=ranked (literalMatches=0).
periodNoLookback window in days: 7, 30, or 180. Default 30.
countryNoTwo-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY (Creative Center used to quietly return an empty leaderboard for them).
orderByNoSort: for_you, likes, ctr, impressions, or cost. Default for_you.
adFormatNoOptional format filter: spark or non_spark. Served only by the extended fetcher — while it is disabled, adFormat returns 503 filter_unavailable (retryable false, not billed). Omit adFormat for the native leaderboard.
industryNoOptional industry key or label from Creative Center.
objectiveNoOptional campaign objective (e.g. Traffic, Conversion, Reach).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / limit / description
      Previous value: -"Max items to return (default 20, max 20). One Creative Center leaderboard page is ~20 rows; limit only trims that pool — it cannot scan more candidates. Flat 2 credits on Decodo-native; Apify ~1 credit per returned ad (min 2)."New value: +"Max items to return (default 20, max 20). One Creative Center leaderboard page is ~20 rows; limit only trims that pool — it cannot scan more candidates. Flat 2 credits on the native path; the fallback path ~1 credit per returned ad (min 2)."
  2. Changed1 schema field changed
    • changedInput schema / properties / adFormat / description
      Previous value: -"Optional format filter: spark or non_spark."New value: +"Optional format filter: spark or non_spark. Served only by the extended fetcher — while it is disabled, adFormat returns 503 filter_unavailable (retryable false, not billed). Omit adFormat for the native leaderboard."
  3. Changed2 schema fields changed
    • changedInput schema / properties / country / description
      Previous value: -"Two-letter ISO country code. Default US."New value: +"Two-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY (Creative Center used to quietly return an empty leaderboard for them)."
    • changedInput schema / properties / q / description
      Previous value: -"Optional keyword that filters the one ~20-row leaderboard page — not a library search. Case-insensitive whole-word match on title/brandName/industry/objective (hair ≠ wheelchair). There is no tags field. advertiser.name is often null in the default US market. Envelope candidatesScanned is the pre-filter pool size. For a known advertiser, use /tiktok/ad-details by ad id."New value: +"Optional keyword that ranks the one ~20-row leaderboard page — not a library search. Case-insensitive whole-word hits on title/brandName/industry/objective (hair ≠ wheelchair) come first; the rest of TikTok's keyword-ranked page follows as fill (matchedFrom [] on those ads, rankedFill in the envelope). There is no tags field. advertiser.name is often null in the default US market. Envelope candidatesScanned is the pre-filter pool size. For a known advertiser, use /tiktok/ad-details by ad id."
  4. Changed1 schema field changed
    • changedInput schema / properties / match / description
      Previous value: -"Keyword token mode: \"any\" (default, OR) or \"all\" (AND). Zero literal hits → empty ads[] (never an unfiltered soft list)."New value: +"Keyword token mode: \"any\" (default, OR) or \"all\" (AND). Zero whole-word hits still return TikTok's keyword-ranked page as matchBasis=ranked (literalMatches=0)."
  5. Changed1 schema field changed
    • changedInput schema / properties / cache / description
      Previous value: -"Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. Envelope includes cached + cachedAt on hits."New value: +"Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
  6. Changed10 schema fields changed
    • changedInput schema / properties / adFormat / description
      Previous value: -"spark | non_spark."New value: +"Optional format filter: spark or non_spark."
    • changedInput schema / properties / cache / description
      Previous value: -"Serve from 24h cache when available (0 credits on hit)."New value: +"Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. Envelope includes cached + cachedAt on hits."
    • changedInput schema / properties / country / description
      Previous value: -"ISO country code. Default US."New value: +"Two-letter ISO country code. Default US."
    • changedInput schema / properties / industry / description
      Previous value: -"Optional industry key or label."New value: +"Optional industry key or label from Creative Center."
    • changedInput schema / properties / limit / description
      Previous value: -"Max items (default 20, max 100). Flat 2 native; Apify ~1/ad (min 2)."New value: +"Max items to return (default 20, max 20). One Creative Center leaderboard page is ~20 rows; limit only trims that pool — it cannot scan more candidates. Flat 2 credits on Decodo-native; Apify ~1 credit per returned ad (min 2)."
    • changedInput schema / properties / match / description
      Previous value: -"Keyword mode: \"any\" (default) or \"all\"."New value: +"Keyword token mode: \"any\" (default, OR) or \"all\" (AND). Zero literal hits → empty ads[] (never an unfiltered soft list)."
    • changedInput schema / properties / objective / description
      Previous value: -"Optional campaign objective."New value: +"Optional campaign objective (e.g. Traffic, Conversion, Reach)."
    • changedInput schema / properties / orderBy / description
      Previous value: -"for_you | likes | ctr | impressions | cost."New value: +"Sort: for_you, likes, ctr, impressions, or cost. Default for_you."
    • changedInput schema / properties / period / description
      Previous value: -"Lookback days: 7, 30, or 180. Default 30."New value: +"Lookback window in days: 7, 30, or 180. Default 30."
    • changedInput schema / properties / q / description
      Previous value: -"Optional keyword (substring). See match + matchedFrom."New value: +"Optional keyword that filters the one ~20-row leaderboard page — not a library search. Case-insensitive whole-word match on title/brandName/industry/objective (hair ≠ wheelchair). There is no tags field. advertiser.name is often null in the default US market. Envelope candidatesScanned is the pre-filter pool size. For a known advertiser, use /tiktok/ad-details by ad id."
  7. Changed2 schema fields changed
    • changedInput schema / properties / cache / description
      Previous value: -"Set true to serve from the 24h response cache. Default false — always fetch fresh data."New value: +"Serve from 24h cache when available (0 credits on hit)."
    • changedInput schema / properties / limit / description
      Previous value: -"Max items to return. Default 20, max 100. Billed per result."New value: +"Max items (default 20, max 100). Flat 2 native; Apify ~1/ad (min 2)."
  8. Changed2 schema fields changed
    • addedInput schema / properties / match
      Added value: +{
+  "description": "Keyword mode: \"any\" (default) or \"all\".",
+  "type": "string"
+}
    • changedInput schema / properties / q / description
      Previous value: -"Optional keyword filter."New value: +"Optional keyword (substring). See match + matchedFrom."
  9. Added

TDQS

A4.4/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses credit cost (flat 2, ~1/ad on the fallback path), billing edge cases (empty results and failures never charged), and cache semantics (cache=true for a free 24h hit, default always fresh). These are exactly the operational facts an agent needs to call it without surprise charges.

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?

Four tight sentences with zero waste, front-loading what the tool is and what it is not, then the cost/caching facts. Every sentence earns its place.

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?

For a 10-parameter tool with no annotations and no output schema, the description plus the richly documented schema cover purpose, cost behavior, caching, and fallback path. It doesn't itself describe the returned envelope shape, though the parameter descriptions carry that detail, leaving only a minor gap.

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 the schema already documents all ten parameters thoroughly (envelope fields, keyword ranking, fallback pricing). The description adds only marginal parameter-level meaning beyond that, so the baseline of 3 is appropriate.

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 and scope ("TikTok Creative Center Top Ads — one ~20-row leaderboard page") and explicitly distinguishes itself from the sibling "library search" (tiktok_ad_library_search). An agent can tell what this returns and how it differs from siblings without opening a schema.

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?

Explicitly negates the alternative use case ("not a library search"), and the q parameter routes a known-advertiser lookup to /tiktok/ad-details by ad id. Clear context for when to reach for this tool; it stops just short of naming the library-search sibling by name in the description itself.

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

All Captapi toolsInspect
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