@datadive-tools/mcp 0.19.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -2
- package/dist/index.js +723 -383
- package/dist/index.js.map +1 -1
- package/dist/lib.js +723 -383
- package/dist/lib.js.map +1 -1
- package/package.json +1 -1
package/dist/lib.js
CHANGED
|
@@ -22,7 +22,7 @@ function loadConfig(env = process.env) {
|
|
|
22
22
|
}
|
|
23
23
|
|
|
24
24
|
// src/tools/list-niches.ts
|
|
25
|
-
import { z } from "zod";
|
|
25
|
+
import { z as z2 } from "zod";
|
|
26
26
|
|
|
27
27
|
// src/http/errors.ts
|
|
28
28
|
var KEY_HELP_URL2 = "https://2.datadive.tools/api-key";
|
|
@@ -139,7 +139,7 @@ function extractMessage(body) {
|
|
|
139
139
|
}
|
|
140
140
|
|
|
141
141
|
// package.json
|
|
142
|
-
var version = "0.
|
|
142
|
+
var version = "0.20.0";
|
|
143
143
|
|
|
144
144
|
// src/http/client.ts
|
|
145
145
|
var PKG_VERSION = version;
|
|
@@ -271,6 +271,10 @@ function buildUrl(baseUrl, path, query) {
|
|
|
271
271
|
if (query) {
|
|
272
272
|
for (const [k, v] of Object.entries(query)) {
|
|
273
273
|
if (v === void 0 || v === null) continue;
|
|
274
|
+
if (Array.isArray(v)) {
|
|
275
|
+
for (const item of v) u.searchParams.append(k, String(item));
|
|
276
|
+
continue;
|
|
277
|
+
}
|
|
274
278
|
u.searchParams.set(k, String(v));
|
|
275
279
|
}
|
|
276
280
|
}
|
|
@@ -303,24 +307,111 @@ function isObject(v) {
|
|
|
303
307
|
return typeof v === "object" && v !== null && !Array.isArray(v);
|
|
304
308
|
}
|
|
305
309
|
|
|
310
|
+
// src/tools/niche-tag-ids.ts
|
|
311
|
+
import { z } from "zod";
|
|
312
|
+
|
|
313
|
+
// src/types/api.ts
|
|
314
|
+
var ISO_8601 = /^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?(?:Z|[+-]\d{2}:?\d{2})?)?$/;
|
|
315
|
+
var SUPPORTED_MARKETPLACES = [
|
|
316
|
+
"com",
|
|
317
|
+
"ca",
|
|
318
|
+
"co.uk",
|
|
319
|
+
"com.mx",
|
|
320
|
+
"in",
|
|
321
|
+
"fr",
|
|
322
|
+
"de",
|
|
323
|
+
"es",
|
|
324
|
+
"it",
|
|
325
|
+
"co.jp"
|
|
326
|
+
];
|
|
327
|
+
var NICHE_TAG_IDS_MAX_PER_CALL = 100;
|
|
328
|
+
var NICHE_KEYWORDS_MAX_PER_CALL = 100;
|
|
329
|
+
var NICHE_KEYWORD_MAX_LENGTH = 255;
|
|
330
|
+
var KEYWORD_EXCLUSIONS_MAX_PER_CALL = 100;
|
|
331
|
+
var KEYWORD_EXCLUSIONS_MAX_PER_NICHE = 1e3;
|
|
332
|
+
var RANK_RADAR_STATES = ["ACTIVE", "PAUSED", "ARCHIVED"];
|
|
333
|
+
var RANK_RADAR_STATUSES = [...RANK_RADAR_STATES, "ALL"];
|
|
334
|
+
var TAG_TITLE_MAX_LENGTH = 100;
|
|
335
|
+
var TAG_KEYWORD_IDS_MAX = 1e3;
|
|
336
|
+
var TAG_RESERVED_COLOR = "#EB5757";
|
|
337
|
+
var TAG_HEX_COLOR_PATTERN = /^#[0-9A-Fa-f]{6}$/;
|
|
338
|
+
var PPC_CAMPAIGN_BASE_SORT_BY = [
|
|
339
|
+
"name",
|
|
340
|
+
"state",
|
|
341
|
+
"bidStrategy",
|
|
342
|
+
"budget",
|
|
343
|
+
"impressions",
|
|
344
|
+
"clicks",
|
|
345
|
+
"ctr",
|
|
346
|
+
"cpc",
|
|
347
|
+
"spend",
|
|
348
|
+
"unitsSold",
|
|
349
|
+
"sales",
|
|
350
|
+
"acos",
|
|
351
|
+
"cvr",
|
|
352
|
+
"tosImpressionShare"
|
|
353
|
+
];
|
|
354
|
+
var PPC_CAMPAIGN_PLACEMENT_SORT_BY = [
|
|
355
|
+
...["tos", "ros", "pp", "off"].flatMap(
|
|
356
|
+
(p) => ["Impressions", "Clicks", "Spend", "Sales", "UnitsSold", "Ctr", "Cpc", "Acos"].map(
|
|
357
|
+
(m) => `${p}${m}`
|
|
358
|
+
)
|
|
359
|
+
),
|
|
360
|
+
"tosBidAdjustment",
|
|
361
|
+
"rosBidAdjustment",
|
|
362
|
+
"ppBidAdjustment"
|
|
363
|
+
];
|
|
364
|
+
var PPC_CAMPAIGN_STATES = ["ENABLED", "PAUSED"];
|
|
365
|
+
var ALERT_STATUSES = ["active", "resolved", "all"];
|
|
366
|
+
var BILLABLE_FEATURE_TYPES = [
|
|
367
|
+
"DIVED_ASINS",
|
|
368
|
+
"PRODUCT_BRIEF_ASINS",
|
|
369
|
+
"AI_COPYWRITER_PROMPTS",
|
|
370
|
+
"RANK_RADAR_KEYWORDS"
|
|
371
|
+
];
|
|
372
|
+
var CATALOG_STATUSES = ["Active", "all"];
|
|
373
|
+
var LISTING_CHANGE_TYPES = ["Price", "Content", "Image"];
|
|
374
|
+
var LISTING_CHANGE_SORT_BY = ["date", "type"];
|
|
375
|
+
var SORT_ORDER = ["ASC", "DESC"];
|
|
376
|
+
var ADD_SEARCH_TERMS_MAX = 1e3;
|
|
377
|
+
var LISTING_COPY_STRATEGIES = ["cosmo", "ranking-juice", "nlp", "cosmo-rufus"];
|
|
378
|
+
var FAST_KEYWORDS_MAX_PAGE_SIZE = 100;
|
|
379
|
+
|
|
380
|
+
// src/tools/niche-tag-ids.ts
|
|
381
|
+
var tagId = () => z.number().int().min(1);
|
|
382
|
+
function unique(schema, field) {
|
|
383
|
+
return schema.refine((ids) => new Set(ids).size === ids.length, {
|
|
384
|
+
message: `${field} must not contain the same id twice`
|
|
385
|
+
});
|
|
386
|
+
}
|
|
387
|
+
var nicheTagIdList = (field) => unique(z.array(tagId()).min(1).max(NICHE_TAG_IDS_MAX_PER_CALL), field);
|
|
388
|
+
var tagFilterIdList = (field) => unique(z.array(tagId()).max(NICHE_TAG_IDS_MAX_PER_CALL), field);
|
|
389
|
+
var NICHE_TAG_WRITE_RULES = "Only the organization owner or a team admin can change a niche's Spaces and labels; anyone else is refused with a 403 (INSUFFICIENT_ROLE), so tell the user instead of retrying. A change is all or nothing: if any id is unknown, or a Space is one the user has only view rights on, the whole call fails and nothing changes (the error lists the offending ids). Ids already in the wanted state are counted, never errors, so a repeat is safe. Costs nothing. Limited to 2 calls per minute per niche, so put every id in one call.";
|
|
390
|
+
|
|
306
391
|
// src/tools/list-niches.ts
|
|
307
392
|
var LIST_NICHES_MAX_PAGE_SIZE = 50;
|
|
308
393
|
var inputSchema = {
|
|
309
|
-
currentPage:
|
|
310
|
-
pageSize:
|
|
311
|
-
searchText:
|
|
394
|
+
currentPage: z2.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1. Keep requesting the next page while `hasNext` is true."),
|
|
395
|
+
pageSize: z2.number().int().min(1).max(LIST_NICHES_MAX_PAGE_SIZE).optional().describe(`Items per page (max ${LIST_NICHES_MAX_PAGE_SIZE}). Defaults to 20.`),
|
|
396
|
+
searchText: z2.string().trim().min(1).max(200).optional().describe(
|
|
312
397
|
"Case-insensitive partial match on the niche label or hero keyword. Prefer this over paging through everything when the user names a niche."
|
|
313
398
|
),
|
|
314
|
-
searchAsin:
|
|
315
|
-
orderBy:
|
|
399
|
+
searchAsin: z2.string().trim().regex(/^[A-Za-z0-9]{10}$/, "must be a 10-character ASIN").optional().describe("Only niches whose competitor set contains this ASIN (10 characters, e.g. B08N5WRWNW)."),
|
|
400
|
+
orderBy: z2.enum(["lastDived", "name"]).optional().describe(
|
|
316
401
|
"Sort field: `lastDived` (by latestResearchDate, newest first by default) or `name` (by nicheLabel, A\u2192Z by default). Defaults to `lastDived`."
|
|
317
402
|
),
|
|
318
|
-
sortOrder:
|
|
403
|
+
sortOrder: z2.enum(["ASC", "DESC"]).optional().describe("Sort direction. Defaults to DESC for `lastDived` and ASC for `name`."),
|
|
404
|
+
spaces: tagFilterIdList("spaces").optional().describe(
|
|
405
|
+
"Only niches in at least one of these Spaces (ids from `list_spaces`, up to 100). Combines with `labels` and the other filters with AND."
|
|
406
|
+
),
|
|
407
|
+
labels: tagFilterIdList("labels").optional().describe(
|
|
408
|
+
"Only niches with at least one of these labels (ids from `list_labels`, up to 100). Combines with `spaces` and the other filters with AND."
|
|
409
|
+
)
|
|
319
410
|
};
|
|
320
411
|
var listNichesTool = {
|
|
321
412
|
name: "list_niches",
|
|
322
413
|
title: "List DataDive Niches",
|
|
323
|
-
description: `Use this first when the user asks about their niches, or to find a \`nicheId\` for use with \`get_niche_keywords\`, \`get_niche_competitors\`, or \`get_ranking_juice\`. Retrieves a paginated list of Niches, newest dive first. Each Niche represents a market segment or product category being tracked. Returns nicheId, heroKeyword, nicheLabel, marketplace (com/uk/de/...), and latestResearchDate per niche, plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev). Narrow with \`searchText\` (label/keyword) or \`searchAsin\` (a competitor ASIN) instead of scanning pages;
|
|
414
|
+
description: `Use this first when the user asks about their niches, or to find a \`nicheId\` for use with \`get_niche_keywords\`, \`get_niche_competitors\`, or \`get_ranking_juice\`. Retrieves a paginated list of Niches, newest dive first. Each Niche represents a market segment or product category being tracked. Returns nicheId, heroKeyword, nicheLabel, marketplace (com/uk/de/...), and latestResearchDate per niche, plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev). Narrow with \`searchText\` (label/keyword) or \`searchAsin\` (a competitor ASIN), \`spaces\` or \`labels\` (ids from \`list_spaces\` / \`list_labels\`) instead of scanning pages; each niche lists the ids of its \`spaces\` and \`labels\`. A page holds at most ${LIST_NICHES_MAX_PAGE_SIZE} niches, so the full list of a large account needs several calls.`,
|
|
324
415
|
inputSchema,
|
|
325
416
|
annotations: { readOnlyHint: true },
|
|
326
417
|
handler: async (args, ctx) => {
|
|
@@ -333,185 +424,421 @@ var listNichesTool = {
|
|
|
333
424
|
searchText: args.searchText,
|
|
334
425
|
searchAsin: args.searchAsin,
|
|
335
426
|
orderBy: args.orderBy,
|
|
336
|
-
sortOrder: args.sortOrder
|
|
427
|
+
sortOrder: args.sortOrder,
|
|
428
|
+
spaces: args.spaces,
|
|
429
|
+
labels: args.labels
|
|
337
430
|
}
|
|
338
431
|
);
|
|
339
432
|
}
|
|
340
433
|
};
|
|
341
434
|
|
|
342
|
-
// src/tools/
|
|
343
|
-
import { z as
|
|
435
|
+
// src/tools/list-fast-keywords.ts
|
|
436
|
+
import { z as z3 } from "zod";
|
|
344
437
|
var inputSchema2 = {
|
|
345
|
-
|
|
346
|
-
}
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
438
|
+
currentPage: z3.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
439
|
+
pageSize: z3.number().int().min(1).max(FAST_KEYWORDS_MAX_PAGE_SIZE).optional().describe(`Items per page (max ${FAST_KEYWORDS_MAX_PAGE_SIZE}). Defaults to 20.`),
|
|
440
|
+
search: z3.string().trim().min(1).max(200).optional().describe("Case-insensitive partial match on ASIN, product title or brand."),
|
|
441
|
+
marketplace: z3.enum(SUPPORTED_MARKETPLACES).optional().describe("Only Fast Keywords runs from this marketplace.")
|
|
442
|
+
};
|
|
443
|
+
var listFastKeywordsTool = {
|
|
444
|
+
name: "list_fast_keywords",
|
|
445
|
+
title: "List Fast Keywords Runs",
|
|
446
|
+
description: "Use this first when the user asks about their Fast Keywords runs, or to find a `fastKeywordsId` for `get_fast_keywords`, `get_fast_keywords_keywords` or `refresh_fast_keywords`. Fast Keywords finds the keywords a product ranks for from just an ASIN, in minutes and for 1 Dive token, without a full niche dive. Lists the runs of the whole organization, newest request first: `fastKeywordsId`, `asin`, `parentAsin`, `marketplace`, `status` (`in-progress`, `success` or `failed`), `title`, `brand`, `price`, `keywordCount`, `totalSearchVolume`, `top10OrganicRankCount`, `rootCount`, `lastRefreshedAt` and `requestedAt`, plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev). Narrow with `search` or `marketplace`.",
|
|
351
447
|
inputSchema: inputSchema2,
|
|
352
448
|
annotations: { readOnlyHint: true },
|
|
353
449
|
handler: async (args, ctx) => {
|
|
354
|
-
return await httpGet(
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
450
|
+
return await httpGet({ config: ctx.config, toolName: "list_fast_keywords" }, "/v1/fast-keywords", {
|
|
451
|
+
currentPage: args.currentPage,
|
|
452
|
+
pageSize: args.pageSize,
|
|
453
|
+
search: args.search,
|
|
454
|
+
marketplace: args.marketplace
|
|
455
|
+
});
|
|
358
456
|
}
|
|
359
457
|
};
|
|
360
458
|
|
|
361
|
-
// src/tools/
|
|
362
|
-
import { z as
|
|
459
|
+
// src/tools/get-fast-keywords.ts
|
|
460
|
+
import { z as z4 } from "zod";
|
|
363
461
|
var inputSchema3 = {
|
|
364
|
-
|
|
462
|
+
fastKeywordsId: z4.number().int().min(1).describe("The Fast Keywords result id, from `run_fast_keywords`, `refresh_fast_keywords` or `list_fast_keywords`.")
|
|
365
463
|
};
|
|
366
|
-
var
|
|
367
|
-
name: "
|
|
368
|
-
title: "
|
|
369
|
-
description: "Use this to
|
|
464
|
+
var getFastKeywordsTool = {
|
|
465
|
+
name: "get_fast_keywords",
|
|
466
|
+
title: "Get a Fast Keywords Result",
|
|
467
|
+
description: "Use this to poll a Fast Keywords run started with `run_fast_keywords` or `refresh_fast_keywords`, and to read its result. While `status` is `in-progress`, wait a few seconds and call again; stop at `success` or `failed`. On `failed`, `failureReason` and `failureMessage` say why (safe to show to the user). On `success` it returns the product (`title`, `brand`, `price`, `imageUrl`), its `variations`, `keywordCount`, `lastRefreshedAt`, the keyword `roots` (`root`, `aggregateSearchVolume`, `medianOrganicRank`, `keywords`) and the top 10 `competitors`. `insufficientKeywordData: true` means the run succeeded but found too few keywords to be useful. The keyword rows themselves are in `get_fast_keywords_keywords`.",
|
|
370
468
|
inputSchema: inputSchema3,
|
|
371
469
|
annotations: { readOnlyHint: true },
|
|
372
470
|
handler: async (args, ctx) => {
|
|
373
471
|
return await httpGet(
|
|
374
|
-
{ config: ctx.config, toolName: "
|
|
375
|
-
`/v1/
|
|
472
|
+
{ config: ctx.config, toolName: "get_fast_keywords" },
|
|
473
|
+
`/v1/fast-keywords/${args.fastKeywordsId}`
|
|
376
474
|
);
|
|
377
475
|
}
|
|
378
476
|
};
|
|
379
477
|
|
|
380
|
-
// src/tools/get-
|
|
381
|
-
import { z as
|
|
478
|
+
// src/tools/get-fast-keywords-keywords.ts
|
|
479
|
+
import { z as z5 } from "zod";
|
|
382
480
|
var inputSchema4 = {
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
481
|
+
fastKeywordsId: z5.number().int().min(1).describe("The Fast Keywords result id, from `run_fast_keywords` or `list_fast_keywords`."),
|
|
482
|
+
currentPage: z5.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
483
|
+
pageSize: z5.number().int().min(1).max(FAST_KEYWORDS_MAX_PAGE_SIZE).optional().describe(`Keywords per page (max ${FAST_KEYWORDS_MAX_PAGE_SIZE}). Defaults to 20.`)
|
|
484
|
+
};
|
|
485
|
+
var getFastKeywordsKeywordsTool = {
|
|
486
|
+
name: "get_fast_keywords_keywords",
|
|
487
|
+
title: "Get the Keywords of a Fast Keywords Result",
|
|
488
|
+
description: `Use this to read the keywords of a finished Fast Keywords run (check \`status\` is \`success\` with \`get_fast_keywords\` first). Returns \`keyword\`, \`searchVolume\`, \`organicRank\` and \`sponsoredRank\` per keyword, highest search volume first, plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev). A page holds at most ${FAST_KEYWORDS_MAX_PAGE_SIZE} keywords; keep requesting the next page while \`hasNext\` is true.`,
|
|
389
489
|
inputSchema: inputSchema4,
|
|
390
490
|
annotations: { readOnlyHint: true },
|
|
391
491
|
handler: async (args, ctx) => {
|
|
392
492
|
return await httpGet(
|
|
393
|
-
{ config: ctx.config, toolName: "
|
|
394
|
-
`/v1/
|
|
493
|
+
{ config: ctx.config, toolName: "get_fast_keywords_keywords" },
|
|
494
|
+
`/v1/fast-keywords/${args.fastKeywordsId}/keywords`,
|
|
495
|
+
{ currentPage: args.currentPage, pageSize: args.pageSize }
|
|
395
496
|
);
|
|
396
497
|
}
|
|
397
498
|
};
|
|
398
499
|
|
|
399
|
-
// src/tools/
|
|
400
|
-
import { z as
|
|
500
|
+
// src/tools/run-fast-keywords.ts
|
|
501
|
+
import { z as z6 } from "zod";
|
|
502
|
+
|
|
503
|
+
// src/tools/confirm.ts
|
|
504
|
+
function needsConfirmation(confirm, ctx) {
|
|
505
|
+
return !(confirm === true || ctx.config.autoConfirmWrites);
|
|
506
|
+
}
|
|
507
|
+
function confirmationRequired(costNote, warnings) {
|
|
508
|
+
return {
|
|
509
|
+
status: "confirmation_required",
|
|
510
|
+
message: "This action spends billable tokens and cannot be undone. Confirm the cost with the user, then call again with `confirm: true` to proceed.",
|
|
511
|
+
costNote,
|
|
512
|
+
...warnings && warnings.length > 0 ? { warnings } : {}
|
|
513
|
+
};
|
|
514
|
+
}
|
|
515
|
+
function requireConfirmation(confirm, ctx, costNote) {
|
|
516
|
+
if (!needsConfirmation(confirm, ctx)) return null;
|
|
517
|
+
return confirmationRequired(costNote);
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
// src/tools/fast-keywords-run.ts
|
|
521
|
+
function isRefreshConflict(body) {
|
|
522
|
+
if (!body || typeof body !== "object") return false;
|
|
523
|
+
const b = body;
|
|
524
|
+
return b.error === "IN_PROGRESS" || b.error === "COOLDOWN";
|
|
525
|
+
}
|
|
526
|
+
function toConflictError(err) {
|
|
527
|
+
const body = err.body;
|
|
528
|
+
if (!isRefreshConflict(body)) return err;
|
|
529
|
+
const message = body.error === "COOLDOWN" && body.nextEligibleAt ? `This Fast Keywords result was refreshed recently. It can be refreshed again from ${body.nextEligibleAt}. Nothing was run or charged; read the current result with \`get_fast_keywords\`.` : body.error === "IN_PROGRESS" ? "A run for this Fast Keywords result is already in progress. Nothing was charged: poll `get_fast_keywords` until it finishes instead of calling again." : `${body.message} Nothing was run or charged.`;
|
|
530
|
+
return new ApiError("http", 409, message, body);
|
|
531
|
+
}
|
|
532
|
+
async function runFastKeywords(ctx, request, path, body, confirm, what) {
|
|
533
|
+
const post = async (payload) => {
|
|
534
|
+
try {
|
|
535
|
+
return await httpPost(request, path, payload);
|
|
536
|
+
} catch (err) {
|
|
537
|
+
throw err instanceof ApiError && err.status === 409 ? toConflictError(err) : err;
|
|
538
|
+
}
|
|
539
|
+
};
|
|
540
|
+
if (needsConfirmation(confirm, ctx)) {
|
|
541
|
+
const preview = await post({ ...body, dryRun: true });
|
|
542
|
+
if ("fastKeywordsId" in preview) return preview;
|
|
543
|
+
const { tokenCost, hasEnoughTokens } = preview;
|
|
544
|
+
return {
|
|
545
|
+
...confirmationRequired(
|
|
546
|
+
`${what} consumes ${tokenCost} Dive token${tokenCost === 1 ? "" : "s"}.` + (hasEnoughTokens ? "" : " The organization does not have enough Dive tokens left, so a confirmed call would be refused.")
|
|
547
|
+
),
|
|
548
|
+
tokenCost,
|
|
549
|
+
hasEnoughTokens
|
|
550
|
+
};
|
|
551
|
+
}
|
|
552
|
+
return await post(body);
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
// src/tools/run-fast-keywords.ts
|
|
401
556
|
var inputSchema5 = {
|
|
402
|
-
|
|
557
|
+
marketplace: z6.enum(SUPPORTED_MARKETPLACES).describe(
|
|
558
|
+
"Amazon marketplace of the ASIN. Note these are full domain suffixes: com, ca, co.uk, com.mx, in, fr, de, es, it, co.jp (e.g. UK is `co.uk`, not `uk`)."
|
|
559
|
+
),
|
|
560
|
+
asin: z6.string().min(1).describe("The ASIN to find keywords for (e.g. B08N5WRWNW)."),
|
|
561
|
+
confirm: z6.boolean().optional().describe(
|
|
562
|
+
"Leave unset on the first call. Set to true only after the user approved the Dive token cost from the `confirmation_required` response."
|
|
563
|
+
)
|
|
403
564
|
};
|
|
404
|
-
var
|
|
405
|
-
name: "
|
|
406
|
-
title: "
|
|
407
|
-
description: "Use this
|
|
565
|
+
var runFastKeywordsTool = {
|
|
566
|
+
name: "run_fast_keywords",
|
|
567
|
+
title: "Run Fast Keywords",
|
|
568
|
+
description: "Use this to find the keywords a product ranks for from just its ASIN \u2014 in minutes, without a full niche dive. \u26A0\uFE0F Spends 1 Dive token and cannot be undone. The first call checks eligibility and the Dive token balance, spends nothing and returns `confirmation_required` with `tokenCost` and `hasEnoughTokens`; call again with `confirm: true` only after the user approves. Not safe to retry: each confirmed call spends a token \u2014 if it errors or times out, check `list_fast_keywords` instead of re-calling. Returns `fastKeywordsId`, `requestId`, `status` and `estimatedCompletionDate`. Poll `get_fast_keywords` with the `fastKeywordsId` until `status` is `success` (right away when a fresh result for the same product already exists), then read the keywords with `get_fast_keywords_keywords`. To follow up with a full niche dive for the same product, pass the `requestId` to `create_niche_dive` as `fastKeywordsRequestId`. Run it again later with `refresh_fast_keywords`.",
|
|
408
569
|
inputSchema: inputSchema5,
|
|
409
|
-
|
|
570
|
+
// Additive, but it spends a Dive token irreversibly, which is what clients need to prompt on. The confirm
|
|
571
|
+
// gate enforces it server-side regardless.
|
|
572
|
+
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
410
573
|
handler: async (args, ctx) => {
|
|
411
|
-
return await
|
|
412
|
-
|
|
413
|
-
|
|
574
|
+
return await runFastKeywords(
|
|
575
|
+
ctx,
|
|
576
|
+
{ config: ctx.config, toolName: "run_fast_keywords" },
|
|
577
|
+
"/v1/fast-keywords",
|
|
578
|
+
{ marketplace: args.marketplace, asin: args.asin },
|
|
579
|
+
args.confirm,
|
|
580
|
+
"Running Fast Keywords"
|
|
414
581
|
);
|
|
415
582
|
}
|
|
416
583
|
};
|
|
417
584
|
|
|
418
|
-
// src/tools/
|
|
419
|
-
import { z as
|
|
585
|
+
// src/tools/refresh-fast-keywords.ts
|
|
586
|
+
import { z as z7 } from "zod";
|
|
420
587
|
var inputSchema6 = {
|
|
421
|
-
|
|
588
|
+
fastKeywordsId: z7.number().int().min(1).describe("The Fast Keywords result to refresh, from `run_fast_keywords` or `list_fast_keywords`."),
|
|
589
|
+
confirm: z7.boolean().optional().describe(
|
|
590
|
+
"Leave unset on the first call. Set to true only after the user approved the Dive token cost from the `confirmation_required` response."
|
|
591
|
+
)
|
|
422
592
|
};
|
|
423
|
-
var
|
|
424
|
-
name: "
|
|
425
|
-
title: "
|
|
426
|
-
description: "Use this
|
|
593
|
+
var refreshFastKeywordsTool = {
|
|
594
|
+
name: "refresh_fast_keywords",
|
|
595
|
+
title: "Refresh Fast Keywords",
|
|
596
|
+
description: "Use this to re-run an existing Fast Keywords result with current data. \u26A0\uFE0F Spends 1 Dive token and cannot be undone. The first call checks eligibility and the Dive token balance, spends nothing and returns `confirmation_required` with `tokenCost` and `hasEnoughTokens`; call again with `confirm: true` only after the user approves. A result can be refreshed once every 24 hours, and not while a run is going: then the call fails with a message that says when it is refreshable again (or to poll `get_fast_keywords`), and nothing is charged. Not safe to retry after an error or timeout \u2014 check `get_fast_keywords` instead. Returns `fastKeywordsId`, `requestId`, `status` and `estimatedCompletionDate`; poll `get_fast_keywords` until `status` is `success`.",
|
|
427
597
|
inputSchema: inputSchema6,
|
|
598
|
+
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
599
|
+
handler: async (args, ctx) => {
|
|
600
|
+
return await runFastKeywords(
|
|
601
|
+
ctx,
|
|
602
|
+
{ config: ctx.config, toolName: "refresh_fast_keywords" },
|
|
603
|
+
`/v1/fast-keywords/${args.fastKeywordsId}/refresh`,
|
|
604
|
+
{},
|
|
605
|
+
args.confirm,
|
|
606
|
+
"Refreshing Fast Keywords"
|
|
607
|
+
);
|
|
608
|
+
}
|
|
609
|
+
};
|
|
610
|
+
|
|
611
|
+
// src/tools/list-spaces.ts
|
|
612
|
+
var inputSchema7 = {};
|
|
613
|
+
var listSpacesTool = {
|
|
614
|
+
name: "list_spaces",
|
|
615
|
+
title: "List Spaces",
|
|
616
|
+
description: "Use this first when the user talks about Spaces, or to find the `id`s that `add_niche_spaces`, `remove_niche_spaces` and the `spaces` filter of `list_niches` and `list_rank_radars` take. Returns the Spaces as a tree: each node has `id`, `name`, `path` (names from the root joined with `/`), `parentId` and `children`. An MCP user sees only the Spaces they have rights on, so a Space that is missing from the tree is one they cannot use. Niches carry the ids of their Spaces in `spaces` / `labels` on `list_niches`.",
|
|
617
|
+
inputSchema: inputSchema7,
|
|
428
618
|
annotations: { readOnlyHint: true },
|
|
619
|
+
handler: async (_args, ctx) => {
|
|
620
|
+
return await httpGet({ config: ctx.config, toolName: "list_spaces" }, "/v1/spaces");
|
|
621
|
+
}
|
|
622
|
+
};
|
|
623
|
+
|
|
624
|
+
// src/tools/list-labels.ts
|
|
625
|
+
var inputSchema8 = {};
|
|
626
|
+
var listLabelsTool = {
|
|
627
|
+
name: "list_labels",
|
|
628
|
+
title: "List Labels",
|
|
629
|
+
description: "Use this first when the user talks about labels, or to find the `id`s that `add_niche_labels`, `remove_niche_labels` and the `labels` filter of `list_niches` and `list_rank_radars` take. Returns the labels as a tree: each node has `id`, `name`, `path` (names from the root joined with `/`), `parentId` and `children`. Labels carry no access rights, so every label of the organization is listed. Niches carry the ids of their labels in `spaces` / `labels` on `list_niches`.",
|
|
630
|
+
inputSchema: inputSchema8,
|
|
631
|
+
annotations: { readOnlyHint: true },
|
|
632
|
+
handler: async (_args, ctx) => {
|
|
633
|
+
return await httpGet({ config: ctx.config, toolName: "list_labels" }, "/v1/labels");
|
|
634
|
+
}
|
|
635
|
+
};
|
|
636
|
+
|
|
637
|
+
// src/tools/add-niche-spaces.ts
|
|
638
|
+
import { z as z8 } from "zod";
|
|
639
|
+
var inputSchema9 = {
|
|
640
|
+
nicheId: z8.string().min(1).describe("The niche to change. Get one from `list_niches`."),
|
|
641
|
+
spaceIds: nicheTagIdList("spaceIds").describe(
|
|
642
|
+
"The ids of the Spaces to add the niche to, 1-100, unique. Get them from `list_spaces`."
|
|
643
|
+
)
|
|
644
|
+
};
|
|
645
|
+
var addNicheSpacesTool = {
|
|
646
|
+
name: "add_niche_spaces",
|
|
647
|
+
title: "Add a Niche to Spaces",
|
|
648
|
+
description: "Use this to put a niche in one or more Spaces (ids from `list_spaces`). A Space controls who can see the niche, so adding or removing one changes access. Returns `added` and `alreadyPresent`. Undo with `remove_niche_spaces`. " + NICHE_TAG_WRITE_RULES,
|
|
649
|
+
inputSchema: inputSchema9,
|
|
650
|
+
// Like every write tool here: clients prompt on destructiveHint. Changing a Space also changes who can see the niche.
|
|
651
|
+
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
429
652
|
handler: async (args, ctx) => {
|
|
430
|
-
return await
|
|
431
|
-
{ config: ctx.config, toolName: "
|
|
432
|
-
`/v1/niches/${encodeURIComponent(args.nicheId)}/
|
|
653
|
+
return await httpPost(
|
|
654
|
+
{ config: ctx.config, toolName: "add_niche_spaces" },
|
|
655
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/spaces`,
|
|
656
|
+
{ spaceIds: args.spaceIds }
|
|
433
657
|
);
|
|
434
658
|
}
|
|
435
659
|
};
|
|
436
660
|
|
|
437
|
-
// src/tools/
|
|
438
|
-
import { z as
|
|
661
|
+
// src/tools/remove-niche-spaces.ts
|
|
662
|
+
import { z as z9 } from "zod";
|
|
663
|
+
var inputSchema10 = {
|
|
664
|
+
nicheId: z9.string().min(1).describe("The niche to change. Get one from `list_niches`."),
|
|
665
|
+
spaceIds: nicheTagIdList("spaceIds").describe(
|
|
666
|
+
"The ids of the Spaces to take the niche out of, 1-100, unique. Get them from `list_spaces`."
|
|
667
|
+
)
|
|
668
|
+
};
|
|
669
|
+
var removeNicheSpacesTool = {
|
|
670
|
+
name: "remove_niche_spaces",
|
|
671
|
+
title: "Remove a Niche from Spaces",
|
|
672
|
+
description: "Use this to take a niche out of one or more Spaces (ids from `list_spaces`). A Space controls who can see the niche, so adding or removing one changes access. Returns `removed` and `notPresent`. Undo with `add_niche_spaces`. " + NICHE_TAG_WRITE_RULES,
|
|
673
|
+
inputSchema: inputSchema10,
|
|
674
|
+
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
675
|
+
handler: async (args, ctx) => {
|
|
676
|
+
return await httpPost(
|
|
677
|
+
{ config: ctx.config, toolName: "remove_niche_spaces" },
|
|
678
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/spaces/remove`,
|
|
679
|
+
{ spaceIds: args.spaceIds }
|
|
680
|
+
);
|
|
681
|
+
}
|
|
682
|
+
};
|
|
439
683
|
|
|
440
|
-
// src/
|
|
441
|
-
|
|
442
|
-
var
|
|
443
|
-
"
|
|
444
|
-
"
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
"
|
|
450
|
-
"
|
|
451
|
-
"
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
"
|
|
467
|
-
"
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
"
|
|
473
|
-
"
|
|
474
|
-
"
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
var
|
|
492
|
-
|
|
493
|
-
"
|
|
494
|
-
"
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
684
|
+
// src/tools/add-niche-labels.ts
|
|
685
|
+
import { z as z10 } from "zod";
|
|
686
|
+
var inputSchema11 = {
|
|
687
|
+
nicheId: z10.string().min(1).describe("The niche to change. Get one from `list_niches`."),
|
|
688
|
+
labelIds: nicheTagIdList("labelIds").describe(
|
|
689
|
+
"The ids of the labels to add the niche to, 1-100, unique. Get them from `list_labels`."
|
|
690
|
+
)
|
|
691
|
+
};
|
|
692
|
+
var addNicheLabelsTool = {
|
|
693
|
+
name: "add_niche_labels",
|
|
694
|
+
title: "Add Labels to a Niche",
|
|
695
|
+
description: "Use this to put a niche in one or more labels (ids from `list_labels`). Returns `added` and `alreadyPresent`. Undo with `remove_niche_labels`. " + NICHE_TAG_WRITE_RULES,
|
|
696
|
+
inputSchema: inputSchema11,
|
|
697
|
+
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
698
|
+
handler: async (args, ctx) => {
|
|
699
|
+
return await httpPost(
|
|
700
|
+
{ config: ctx.config, toolName: "add_niche_labels" },
|
|
701
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/labels`,
|
|
702
|
+
{ labelIds: args.labelIds }
|
|
703
|
+
);
|
|
704
|
+
}
|
|
705
|
+
};
|
|
706
|
+
|
|
707
|
+
// src/tools/remove-niche-labels.ts
|
|
708
|
+
import { z as z11 } from "zod";
|
|
709
|
+
var inputSchema12 = {
|
|
710
|
+
nicheId: z11.string().min(1).describe("The niche to change. Get one from `list_niches`."),
|
|
711
|
+
labelIds: nicheTagIdList("labelIds").describe(
|
|
712
|
+
"The ids of the labels to take the niche out of, 1-100, unique. Get them from `list_labels`."
|
|
713
|
+
)
|
|
714
|
+
};
|
|
715
|
+
var removeNicheLabelsTool = {
|
|
716
|
+
name: "remove_niche_labels",
|
|
717
|
+
title: "Remove Labels from a Niche",
|
|
718
|
+
description: "Use this to take a niche out of one or more labels (ids from `list_labels`). Returns `removed` and `notPresent`. Undo with `add_niche_labels`. " + NICHE_TAG_WRITE_RULES,
|
|
719
|
+
inputSchema: inputSchema12,
|
|
720
|
+
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
721
|
+
handler: async (args, ctx) => {
|
|
722
|
+
return await httpPost(
|
|
723
|
+
{ config: ctx.config, toolName: "remove_niche_labels" },
|
|
724
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/labels/remove`,
|
|
725
|
+
{ labelIds: args.labelIds }
|
|
726
|
+
);
|
|
727
|
+
}
|
|
728
|
+
};
|
|
729
|
+
|
|
730
|
+
// src/tools/get-niche-keywords.ts
|
|
731
|
+
import { z as z12 } from "zod";
|
|
732
|
+
var inputSchema13 = {
|
|
733
|
+
nicheId: z12.string().min(1).describe("The unique identifier of the Niche (from `list_niches`).")
|
|
734
|
+
};
|
|
735
|
+
var getNicheKeywordsTool = {
|
|
736
|
+
name: "get_niche_keywords",
|
|
737
|
+
title: "Get Master Keyword List for a Niche",
|
|
738
|
+
description: 'Use this when the user asks about keywords, search terms, or search volume for a niche. Retrieves the master keyword list for the specified Niche \u2014 the relevant search terms monitored for ranking and performance metrics. For each keyword, returns search volume, relevancy (numeric score or "Outlier"), and competitor ASIN organic ranks (asinRanks: { ASIN -> rank | null }), plus `origin`: `mkl` (found by the dive), `manual` (added by hand with `add_niche_keywords`), `outlier` / `residue` (moved in from those lists). Only `manual`, `outlier` and `residue` keywords can be taken out with `remove_niche_keywords`. Keywords hidden by the niche\'s keyword exclusions are not listed; see `list_keyword_exclusions`. Also returns the latestResearchDate.',
|
|
739
|
+
inputSchema: inputSchema13,
|
|
740
|
+
annotations: { readOnlyHint: true },
|
|
741
|
+
handler: async (args, ctx) => {
|
|
742
|
+
return await httpGet(
|
|
743
|
+
{ config: ctx.config, toolName: "get_niche_keywords" },
|
|
744
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/keywords`
|
|
745
|
+
);
|
|
746
|
+
}
|
|
747
|
+
};
|
|
748
|
+
|
|
749
|
+
// src/tools/list-keyword-exclusions.ts
|
|
750
|
+
import { z as z13 } from "zod";
|
|
751
|
+
var inputSchema14 = {
|
|
752
|
+
nicheId: z13.string().min(1).describe("The unique identifier of the Niche (from `list_niches`).")
|
|
753
|
+
};
|
|
754
|
+
var listKeywordExclusionsTool = {
|
|
755
|
+
name: "list_keyword_exclusions",
|
|
756
|
+
title: "List a Niche's Keyword Exclusions",
|
|
757
|
+
description: "Use this to see which keywords are hidden from a niche's Master Keyword List, e.g. when a keyword the user expects is missing from `get_niche_keywords`. Returns the same lists the DataDive web app shows, oldest first: `exact` \u2014 each entry hides the one keyword that matches it exactly, with that keyword's `searchVolume` (0 when the niche has no such keyword); `phrase` \u2014 each entry hides every keyword that contains the phrase, with `excludedKeywordsCount` and the total `searchVolume` of the keywords it hides (not counting ones already excluded exactly). Exclusions hide keywords wherever they come from: the dive, the Outliers and Residue lists, and hand-added ones. Change them with `add_keyword_exclusions` and `remove_keyword_exclusions`.",
|
|
758
|
+
inputSchema: inputSchema14,
|
|
759
|
+
annotations: { readOnlyHint: true },
|
|
760
|
+
handler: async (args, ctx) => {
|
|
761
|
+
return await httpGet(
|
|
762
|
+
{ config: ctx.config, toolName: "list_keyword_exclusions" },
|
|
763
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/keyword-exclusions`
|
|
764
|
+
);
|
|
765
|
+
}
|
|
766
|
+
};
|
|
767
|
+
|
|
768
|
+
// src/tools/get-niche-roots.ts
|
|
769
|
+
import { z as z14 } from "zod";
|
|
770
|
+
var inputSchema15 = {
|
|
771
|
+
nicheId: z14.string().min(1).describe("The unique identifier of the Niche (from `list_niches`).")
|
|
772
|
+
};
|
|
773
|
+
var getNicheRootsTool = {
|
|
774
|
+
name: "get_niche_roots",
|
|
775
|
+
title: "Get Keyword Roots for a Niche",
|
|
776
|
+
description: "Use this when the user wants to find the highest-impact words across a niche's keywords, asks about 'keyword roots', or wants to prioritize terms for a listing. Retrieves the keyword lexical roots for the Niche \u2014 individual words or word-combinations extracted from the Master Keyword List (e.g. 'bluetooth headphones' yields roots 'bluetooth', 'headphones', 'bluetooth headphones'). Returns `roots` and `normalizedRoots` tables, each item with root, frequency (how many keywords contain it), broadSearchVolume (summed search volume of those keywords), and broadSearchVolumeRatio (0-1, relative to the top root), plus the per-keyword breakdowns and latestResearchDate.",
|
|
777
|
+
inputSchema: inputSchema15,
|
|
778
|
+
annotations: { readOnlyHint: true },
|
|
779
|
+
handler: async (args, ctx) => {
|
|
780
|
+
return await httpGet(
|
|
781
|
+
{ config: ctx.config, toolName: "get_niche_roots" },
|
|
782
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/roots`
|
|
783
|
+
);
|
|
784
|
+
}
|
|
785
|
+
};
|
|
786
|
+
|
|
787
|
+
// src/tools/get-niche-competitors.ts
|
|
788
|
+
import { z as z15 } from "zod";
|
|
789
|
+
var inputSchema16 = {
|
|
790
|
+
nicheId: z15.string().min(1).describe("The unique identifier of the Niche (from `list_niches`).")
|
|
791
|
+
};
|
|
792
|
+
var getNicheCompetitorsTool = {
|
|
793
|
+
name: "get_niche_competitors",
|
|
794
|
+
title: "Get Competitors and Niche Statistics",
|
|
795
|
+
description: "Use this for competitor ASINs, product titles, BSR, sales/revenue benchmarks, or niche opportunity scoring. Retrieves the list of Competitors within the specified Niche along with Niche statistics. For the Niche: keyword statistics, opportunity evaluation, benchmark median values, and overall competitor strength assessment. For each Competitor: ASIN, product title, BSR, category and full category tree, sales, revenue, ratings, reviews, price, number of variations, image URL, total Ranking Juice, and ranking data. BSR supports ranking Competitors by sales position within mentioned category. For the Ranking Juice breakdown by title, bullets and description, use `get_ranking_juice`.",
|
|
796
|
+
inputSchema: inputSchema16,
|
|
797
|
+
annotations: { readOnlyHint: true },
|
|
798
|
+
handler: async (args, ctx) => {
|
|
799
|
+
return await httpGet(
|
|
800
|
+
{ config: ctx.config, toolName: "get_niche_competitors" },
|
|
801
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/competitors`
|
|
802
|
+
);
|
|
803
|
+
}
|
|
804
|
+
};
|
|
805
|
+
|
|
806
|
+
// src/tools/get-ranking-juice.ts
|
|
807
|
+
import { z as z16 } from "zod";
|
|
808
|
+
var inputSchema17 = {
|
|
809
|
+
nicheId: z16.string().min(1).describe("The unique identifier of the Niche (from `list_niches`).")
|
|
810
|
+
};
|
|
811
|
+
var getRankingJuiceTool = {
|
|
812
|
+
name: "get_ranking_juice",
|
|
813
|
+
title: "Get Ranking Juices for a Niche",
|
|
814
|
+
description: "Use this when the user asks 'how do I rank higher', 'what's my ranking juice', or wants listing-optimization guidance. Retrieves the Ranking Juices for each Competitor within the specified Niche. Ranking Juice is DataDive's proprietary metric identifying the key factors driving search-ranking success for each Competitor's listing. Returns currentListing and optimizedListing breakdowns (rankingJuice + per-property contributions: title, bullets, description) plus per-competitor listing scores and the latestResearchDate.",
|
|
815
|
+
inputSchema: inputSchema17,
|
|
816
|
+
annotations: { readOnlyHint: true },
|
|
817
|
+
handler: async (args, ctx) => {
|
|
818
|
+
return await httpGet(
|
|
819
|
+
{ config: ctx.config, toolName: "get_ranking_juice" },
|
|
820
|
+
`/v1/niches/${encodeURIComponent(args.nicheId)}/ranking-juices`
|
|
821
|
+
);
|
|
822
|
+
}
|
|
823
|
+
};
|
|
504
824
|
|
|
505
825
|
// src/tools/list-rank-radars.ts
|
|
826
|
+
import { z as z17 } from "zod";
|
|
506
827
|
var LIST_RANK_RADARS_MAX_PAGE_SIZE = 50;
|
|
507
|
-
var
|
|
508
|
-
currentPage:
|
|
509
|
-
pageSize:
|
|
510
|
-
nicheId:
|
|
511
|
-
status:
|
|
828
|
+
var inputSchema18 = {
|
|
829
|
+
currentPage: z17.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
830
|
+
pageSize: z17.number().int().min(1).max(LIST_RANK_RADARS_MAX_PAGE_SIZE).optional().describe(`Items per page (max ${LIST_RANK_RADARS_MAX_PAGE_SIZE}). Defaults to 20.`),
|
|
831
|
+
nicheId: z17.string().min(1).optional().describe("Filter Rank Radars by Niche identifier. Use after `list_niches`."),
|
|
832
|
+
status: z17.enum(RANK_RADAR_STATUSES).optional().describe(
|
|
512
833
|
"Which Rank Radars to return. ACTIVE (the default) are tracking; PAUSED have been stopped but keep their history and can be resumed; ARCHIVED have been deleted; ALL means active and paused together. Archived Rank Radars are returned only by an explicit ARCHIVED."
|
|
513
834
|
),
|
|
514
|
-
searchText:
|
|
835
|
+
searchText: z17.string().optional().describe("Filter Rank Radars by ASIN or product title."),
|
|
836
|
+
spaces: tagFilterIdList("spaces").optional().describe(
|
|
837
|
+
"Only Rank Radars whose niche is in at least one of these Spaces (ids from `list_spaces`, up to 100). Combines with `labels` and the other filters with AND."
|
|
838
|
+
),
|
|
839
|
+
labels: tagFilterIdList("labels").optional().describe(
|
|
840
|
+
"Only Rank Radars whose niche has at least one of these labels (ids from `list_labels`, up to 100). Combines with `spaces` and the other filters with AND."
|
|
841
|
+
)
|
|
515
842
|
};
|
|
516
843
|
function minimize(item) {
|
|
517
844
|
const { asin, ...rest } = item;
|
|
@@ -520,8 +847,8 @@ function minimize(item) {
|
|
|
520
847
|
var listRankRadarsTool = {
|
|
521
848
|
name: "list_rank_radars",
|
|
522
849
|
title: "List Rank Radars",
|
|
523
|
-
description: `Use this to find a \`rankRadarId\` before calling \`get_rank_radar_data\`. Filter by \`nicheId\` if the user has already identified a niche. Retrieves a paginated list of Rank Radars \u2014 keyword-rank trackers monitoring organic and sponsored positions for specific ASINs over time. Each item includes id, status (ACTIVE, PAUSED or ARCHIVED), asin, marketplace, keywordCount, title, imageUrl, and summary metrics: top10KW, top10SV, top50KW, top50SV. Supports pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev); a page holds at most ${LIST_RANK_RADARS_MAX_PAGE_SIZE} Rank Radars, so a large account needs several calls.`,
|
|
524
|
-
inputSchema:
|
|
850
|
+
description: `Use this to find a \`rankRadarId\` before calling \`get_rank_radar_data\`. Filter by \`nicheId\` if the user has already identified a niche, or by \`spaces\` / \`labels\` (ids from \`list_spaces\` / \`list_labels\`), which match through the Rank Radar's niche. Retrieves a paginated list of Rank Radars \u2014 keyword-rank trackers monitoring organic and sponsored positions for specific ASINs over time. Each item includes id, status (ACTIVE, PAUSED or ARCHIVED), asin, marketplace, keywordCount, title, imageUrl, and summary metrics: top10KW, top10SV, top50KW, top50SV. Supports pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev); a page holds at most ${LIST_RANK_RADARS_MAX_PAGE_SIZE} Rank Radars, so a large account needs several calls.`,
|
|
851
|
+
inputSchema: inputSchema18,
|
|
525
852
|
annotations: { readOnlyHint: true },
|
|
526
853
|
handler: async (args, ctx) => {
|
|
527
854
|
const page = await httpGet(
|
|
@@ -532,7 +859,9 @@ var listRankRadarsTool = {
|
|
|
532
859
|
pageSize: args.pageSize,
|
|
533
860
|
nicheId: args.nicheId,
|
|
534
861
|
status: args.status,
|
|
535
|
-
searchText: args.searchText
|
|
862
|
+
searchText: args.searchText,
|
|
863
|
+
spaces: args.spaces,
|
|
864
|
+
labels: args.labels
|
|
536
865
|
}
|
|
537
866
|
);
|
|
538
867
|
return { ...page, data: (page.data ?? []).map(minimize) };
|
|
@@ -540,18 +869,18 @@ var listRankRadarsTool = {
|
|
|
540
869
|
};
|
|
541
870
|
|
|
542
871
|
// src/tools/rank-radar-keyword-query.ts
|
|
543
|
-
import { z as
|
|
872
|
+
import { z as z18 } from "zod";
|
|
544
873
|
var ISO_DATE = /^\d{4}-\d{2}-\d{2}$/;
|
|
545
874
|
var RANK_RADAR_KEYWORDS_MAX_PAGE_SIZE = 100;
|
|
546
875
|
var RANK_RADAR_MAX_DATE_RANGE_DAYS = 90;
|
|
547
876
|
var rankRadarKeywordQueryInputSchema = {
|
|
548
|
-
rankRadarId:
|
|
549
|
-
startDate:
|
|
550
|
-
endDate:
|
|
877
|
+
rankRadarId: z18.string().uuid().describe("The Rank Radar UUID (from `list_rank_radars`)."),
|
|
878
|
+
startDate: z18.string().regex(ISO_DATE, "startDate must be in yyyy-mm-dd format").describe("Start date of the range, yyyy-mm-dd (e.g. 2024-03-26)."),
|
|
879
|
+
endDate: z18.string().regex(ISO_DATE, "endDate must be in yyyy-mm-dd format").describe(
|
|
551
880
|
`End date of the range, yyyy-mm-dd (e.g. 2024-04-26). Must be on or after startDate, and at most ${RANK_RADAR_MAX_DATE_RANGE_DAYS} days after it.`
|
|
552
881
|
),
|
|
553
|
-
currentPage:
|
|
554
|
-
pageSize:
|
|
882
|
+
currentPage: z18.number().int().min(1).optional().describe("Page of keywords, 1-indexed. Defaults to 1."),
|
|
883
|
+
pageSize: z18.number().int().min(1).max(RANK_RADAR_KEYWORDS_MAX_PAGE_SIZE).optional().describe(`Keywords per page (max ${RANK_RADAR_KEYWORDS_MAX_PAGE_SIZE}). Defaults to 20.`)
|
|
555
884
|
};
|
|
556
885
|
var RANK_RADAR_KEYWORD_PAGING_NOTE = `Results are paged by keyword: \`data\` holds one page, and the response carries currentPage, pageSize, total, lastPage, hasNext and hasPrev. \`total\` is the Rank Radar's active keyword count; to read every keyword, call again with \`currentPage\` + 1 while \`hasNext\` is true, using \`pageSize\` ${RANK_RADAR_KEYWORDS_MAX_PAGE_SIZE} for large Rank Radars. Paused keywords are not included.`;
|
|
557
886
|
function rankRadarPath(rankRadarId, suffix = "") {
|
|
@@ -567,7 +896,7 @@ function rankRadarKeywordQuery(args) {
|
|
|
567
896
|
}
|
|
568
897
|
|
|
569
898
|
// src/tools/get-rank-radar-data.ts
|
|
570
|
-
var
|
|
899
|
+
var inputSchema19 = rankRadarKeywordQueryInputSchema;
|
|
571
900
|
async function readAllKeywords(args, ctx) {
|
|
572
901
|
const request = { config: ctx.config, toolName: "get_rank_radar_data" };
|
|
573
902
|
const path = rankRadarPath(args.rankRadarId);
|
|
@@ -597,7 +926,7 @@ var getRankRadarDataTool = {
|
|
|
597
926
|
name: "get_rank_radar_data",
|
|
598
927
|
title: "Get Keyword Rankings for a Rank Radar",
|
|
599
928
|
description: `Use this to analyze keyword ranking trends over time. Requires startDate and endDate (yyyy-mm-dd), at most ${RANK_RADAR_MAX_DATE_RANGE_DAYS} days apart. Retrieves historical keyword ranking data for the specified Rank Radar within the date range. Without \`currentPage\` and \`pageSize\` it returns every active keyword in one result. To read one page instead \u2014 faster for large Rank Radars \u2014 pass \`currentPage\` and/or \`pageSize\` (max ${RANK_RADAR_KEYWORDS_MAX_PAGE_SIZE}) and continue with \`currentPage\` + 1 while \`hasNext\` is true. The response carries currentPage, pageSize, total, lastPage, hasNext and hasPrev; \`total\` is the Rank Radar's active keyword count. Paused keywords are not included. Each keyword has id, keyword, searchVolume, relevancy, ranks (per-day { date, organicRank, sponsoredRank, impressionRank }), and \`highlights\` \u2014 the user tags on this keyword. Each \`highlights\` entry is the same object \`list_rank_radar_tags\` returns (id, title, color, description, startAt, endAt, type, krtId, krtKeywordId); its \`id\` is the \`tagId\` the tag-management tools take. A rank of 101 means the product was not in the top 100 results that day. For PPC metrics use \`get_rank_radar_ppc_data\`; for Search Query Performance use \`get_rank_radar_sqp_data\`. Use after \`list_rank_radars\` to discover a \`rankRadarId\`.`,
|
|
600
|
-
inputSchema:
|
|
929
|
+
inputSchema: inputSchema19,
|
|
601
930
|
annotations: { readOnlyHint: true },
|
|
602
931
|
handler: async (args, ctx) => {
|
|
603
932
|
if (args.currentPage === void 0 && args.pageSize === void 0) {
|
|
@@ -612,12 +941,12 @@ var getRankRadarDataTool = {
|
|
|
612
941
|
};
|
|
613
942
|
|
|
614
943
|
// src/tools/get-rank-radar-sqp-data.ts
|
|
615
|
-
var
|
|
944
|
+
var inputSchema20 = rankRadarKeywordQueryInputSchema;
|
|
616
945
|
var getRankRadarSqpDataTool = {
|
|
617
946
|
name: "get_rank_radar_sqp_data",
|
|
618
947
|
title: "Get Search Query Performance for a Rank Radar",
|
|
619
948
|
description: `Use this when the user asks how shoppers search, click, add to cart and buy for the keywords of a Rank Radar \u2014 Amazon's Search Query Performance (SQP) data, from Brand Analytics. Requires startDate and endDate (yyyy-mm-dd), at most ${RANK_RADAR_MAX_DATE_RANGE_DAYS} days apart; 30 days or less keeps it fast. Each keyword's metrics are aggregated over the range: searchQueryVolume and searchQueryScore; impressions, clicks, cart adds and purchases, each as the total across all sellers (\`*TotalCount\`), this ASIN family's count (\`*AsinCount\`) and its share (\`*AsinShare\`); click, cart-add and purchase rates; and ctr/cvr for the market (\`*Total\`) and for this ASIN family (\`*Asin\`). \`numberOfDaysWithData\` says how many days of the range had SQP data; metrics are null when there is none, which is normal for low-volume keywords, recent dates (Amazon publishes SQP with a delay) and sellers without Brand Analytics. ${RANK_RADAR_KEYWORD_PAGING_NOTE} Each call counts toward API usage and is rate limited (about 60 requests/minute). Use after \`list_rank_radars\` to discover a \`rankRadarId\`.`,
|
|
620
|
-
inputSchema:
|
|
949
|
+
inputSchema: inputSchema20,
|
|
621
950
|
annotations: { readOnlyHint: true },
|
|
622
951
|
handler: async (args, ctx) => {
|
|
623
952
|
return await httpGet(
|
|
@@ -629,10 +958,10 @@ var getRankRadarSqpDataTool = {
|
|
|
629
958
|
};
|
|
630
959
|
|
|
631
960
|
// src/tools/get-rank-radar-ppc-data.ts
|
|
632
|
-
import { z as
|
|
633
|
-
var
|
|
961
|
+
import { z as z19 } from "zod";
|
|
962
|
+
var inputSchema21 = {
|
|
634
963
|
...rankRadarKeywordQueryInputSchema,
|
|
635
|
-
includeCampaigns:
|
|
964
|
+
includeCampaigns: z19.boolean().optional().describe(
|
|
636
965
|
"When true, each keyword also carries `campaigns`: the per-campaign/ad-group breakdown (campaign and ad group name, match type, targeting, spend, sales, clicks, impressions, orders, CPC, CTR, CVR, ACOS). Defaults to false; leave it off unless the user asks which campaigns drive a keyword."
|
|
637
966
|
)
|
|
638
967
|
};
|
|
@@ -640,7 +969,7 @@ var getRankRadarPpcDataTool = {
|
|
|
640
969
|
name: "get_rank_radar_ppc_data",
|
|
641
970
|
title: "Get PPC Data for a Rank Radar",
|
|
642
971
|
description: `Use this when the user asks about advertising (Sponsored Products) performance for the keywords of a Rank Radar. Requires startDate and endDate (yyyy-mm-dd), at most ${RANK_RADAR_MAX_DATE_RANGE_DAYS} days apart; 30 days or less keeps it fast. Each keyword's metrics are aggregated over the range: sponsoredRank (median; 101 means not in the top 100 sponsored results), impressionRank and impressionRankShare; how many exact, phrase, broad and auto campaigns target it; organicSales, ppcSales, ppcSpend, costPerClicks, clickThroughRate, conversionRate, totalClicks, totalImpressions, totalOrders and acos. Metrics are null or 0 when the seller runs no ads on a keyword. Set \`includeCampaigns\` for the per-campaign breakdown. ${RANK_RADAR_KEYWORD_PAGING_NOTE} Each call counts toward API usage and is rate limited (about 60 requests/minute). For the seller's campaigns as a whole, use \`list_ppc_campaigns\`. Use after \`list_rank_radars\` to discover a \`rankRadarId\`.`,
|
|
643
|
-
inputSchema:
|
|
972
|
+
inputSchema: inputSchema21,
|
|
644
973
|
annotations: { readOnlyHint: true },
|
|
645
974
|
handler: async (args, ctx) => {
|
|
646
975
|
return await httpGet(
|
|
@@ -652,32 +981,13 @@ var getRankRadarPpcDataTool = {
|
|
|
652
981
|
};
|
|
653
982
|
|
|
654
983
|
// src/tools/create-rank-radar.ts
|
|
655
|
-
import { z as
|
|
656
|
-
|
|
657
|
-
// src/tools/confirm.ts
|
|
658
|
-
function needsConfirmation(confirm, ctx) {
|
|
659
|
-
return !(confirm === true || ctx.config.autoConfirmWrites);
|
|
660
|
-
}
|
|
661
|
-
function confirmationRequired(costNote, warnings) {
|
|
662
|
-
return {
|
|
663
|
-
status: "confirmation_required",
|
|
664
|
-
message: "This action spends billable tokens and cannot be undone. Confirm the cost with the user, then call again with `confirm: true` to proceed.",
|
|
665
|
-
costNote,
|
|
666
|
-
...warnings && warnings.length > 0 ? { warnings } : {}
|
|
667
|
-
};
|
|
668
|
-
}
|
|
669
|
-
function requireConfirmation(confirm, ctx, costNote) {
|
|
670
|
-
if (!needsConfirmation(confirm, ctx)) return null;
|
|
671
|
-
return confirmationRequired(costNote);
|
|
672
|
-
}
|
|
673
|
-
|
|
674
|
-
// src/tools/create-rank-radar.ts
|
|
984
|
+
import { z as z20 } from "zod";
|
|
675
985
|
var PATH = "/v1/niches/rank-radars";
|
|
676
|
-
var
|
|
677
|
-
asin:
|
|
678
|
-
numberOfKeywords:
|
|
679
|
-
nicheId:
|
|
680
|
-
confirm:
|
|
986
|
+
var inputSchema22 = {
|
|
987
|
+
asin: z20.string().min(1).describe("The ASIN to track keyword rankings for."),
|
|
988
|
+
numberOfKeywords: z20.number().int().min(1).describe("How many keywords to track (minimum 1). More keywords = broader tracking but more Search Term tokens."),
|
|
989
|
+
nicheId: z20.string().min(1).describe("The niche this Rank Radar belongs to. Get one from `list_niches`."),
|
|
990
|
+
confirm: z20.boolean().optional().describe(
|
|
681
991
|
"Must be true to proceed \u2014 creating a Rank Radar spends Search Term tokens. Confirm the cost with the user first."
|
|
682
992
|
)
|
|
683
993
|
};
|
|
@@ -685,7 +995,7 @@ var createRankRadarTool = {
|
|
|
685
995
|
name: "create_rank_radar",
|
|
686
996
|
title: "Create a Rank Radar",
|
|
687
997
|
description: "Use this to start tracking organic and sponsored keyword rankings for an ASIN within a niche. \u26A0\uFE0F Spends Search Term tokens (cost scales with `numberOfKeywords`) and cannot be undone \u2014 set `confirm: true` only after the user approves the cost. Not safe to retry: each call spends tokens again and creates a separate Rank Radar \u2014 if a call errors or times out, check `list_rank_radars` instead of re-calling. The first call previews the creation and may return `warnings` alongside the cost note \u2014 for example that this product family is already tracked by another Rank Radar. Show every warning `message` to the user verbatim, before asking them to confirm; do not summarise it or decide on their behalf. A warning never blocks creation. Returns the new `rankRadarId`; read its data later with `get_rank_radar_data`. Requires `asin`, `numberOfKeywords` (min 1), and a `nicheId` from `list_niches`.",
|
|
688
|
-
inputSchema:
|
|
998
|
+
inputSchema: inputSchema22,
|
|
689
999
|
// destructiveHint is technically "additive" here (this creates a new Rank Radar, it
|
|
690
1000
|
// doesn't destroy data), but we flag it destructive so clients prompt before the
|
|
691
1001
|
// irreversible token spend. The confirm gate enforces this server-side regardless.
|
|
@@ -710,20 +1020,23 @@ var createRankRadarTool = {
|
|
|
710
1020
|
};
|
|
711
1021
|
|
|
712
1022
|
// src/tools/create-niche-dive.ts
|
|
713
|
-
import { z as
|
|
714
|
-
var
|
|
715
|
-
marketplace:
|
|
1023
|
+
import { z as z21 } from "zod";
|
|
1024
|
+
var inputSchema23 = {
|
|
1025
|
+
marketplace: z21.enum(SUPPORTED_MARKETPLACES).describe(
|
|
716
1026
|
"Amazon marketplace of the seed ASIN. Note these are full domain suffixes: com, ca, co.uk, com.mx, in, fr, de, es, it, co.jp (e.g. UK is `co.uk`, not `uk`)."
|
|
717
1027
|
),
|
|
718
|
-
asin:
|
|
719
|
-
numberOfCompetitors:
|
|
720
|
-
|
|
1028
|
+
asin: z21.string().min(1).describe("The seed ASIN to start the dive from (e.g. B08N5WRWNW). Competitors are built around it."),
|
|
1029
|
+
numberOfCompetitors: z21.number().int().min(2).describe("How many competitors to analyze (minimum 2). More competitors = deeper niche but more dive tokens."),
|
|
1030
|
+
fastKeywordsRequestId: z21.number().int().min(1).optional().describe(
|
|
1031
|
+
"Links the dive to a Fast Keywords run for the same product: the `requestId` returned by `run_fast_keywords` or `refresh_fast_keywords`. Leave unset for a dive that follows no Fast Keywords run."
|
|
1032
|
+
),
|
|
1033
|
+
confirm: z21.boolean().optional().describe("Must be true to proceed \u2014 creating a dive spends dive tokens. Confirm the cost with the user first.")
|
|
721
1034
|
};
|
|
722
1035
|
var createNicheDiveTool = {
|
|
723
1036
|
name: "create_niche_dive",
|
|
724
1037
|
title: "Create a Niche Dive",
|
|
725
|
-
description: "Use this to start new niche research from a seed ASIN. \u26A0\uFE0F Spends dive tokens (cost scales with `numberOfCompetitors`) and cannot be undone \u2014 set `confirm: true` only after the user approves the cost. Not safe to retry: each call spends tokens again and starts a separate dive \u2014 if a call errors or times out, poll `get_dive_status` (or check `list_niches`) instead of re-calling. The dive runs asynchronously: this returns immediately with a `diveId` and an `estimatedCompletionDate`. Poll `get_dive_status` with that `diveId` until it reports `success` (which carries the new `nicheId` for use with `list_niches`, `get_niche_keywords`, etc.). Requires `marketplace`, `asin`, and `numberOfCompetitors` (min 2).",
|
|
726
|
-
inputSchema:
|
|
1038
|
+
description: "Use this to start new niche research from a seed ASIN. \u26A0\uFE0F Spends dive tokens (cost scales with `numberOfCompetitors`) and cannot be undone \u2014 set `confirm: true` only after the user approves the cost. Not safe to retry: each call spends tokens again and starts a separate dive \u2014 if a call errors or times out, poll `get_dive_status` (or check `list_niches`) instead of re-calling. The dive runs asynchronously: this returns immediately with a `diveId` and an `estimatedCompletionDate`. Poll `get_dive_status` with that `diveId` until it reports `success` (which carries the new `nicheId` for use with `list_niches`, `get_niche_keywords`, etc.). Requires `marketplace`, `asin`, and `numberOfCompetitors` (min 2). After a Fast Keywords run for the same product, pass its `requestId` as `fastKeywordsRequestId` to link the dive to it.",
|
|
1039
|
+
inputSchema: inputSchema23,
|
|
727
1040
|
// destructiveHint is technically "additive" here (a dive creates a new niche, it
|
|
728
1041
|
// doesn't destroy data), but we flag it destructive so clients prompt before the
|
|
729
1042
|
// irreversible token spend. The confirm gate enforces this server-side regardless.
|
|
@@ -741,27 +1054,29 @@ var createNicheDiveTool = {
|
|
|
741
1054
|
{
|
|
742
1055
|
marketplace: args.marketplace,
|
|
743
1056
|
asin: args.asin,
|
|
744
|
-
numberOfCompetitors: args.numberOfCompetitors
|
|
1057
|
+
numberOfCompetitors: args.numberOfCompetitors,
|
|
1058
|
+
// JSON.stringify drops it when unset, so a dive without a Fast Keywords run sends the old body.
|
|
1059
|
+
fastKeywordsRequestId: args.fastKeywordsRequestId
|
|
745
1060
|
}
|
|
746
1061
|
);
|
|
747
1062
|
}
|
|
748
1063
|
};
|
|
749
1064
|
|
|
750
1065
|
// src/tools/create-niche-dive-from-competitors-list.ts
|
|
751
|
-
import { z as
|
|
1066
|
+
import { z as z22 } from "zod";
|
|
752
1067
|
var DIVE_FROM_COMPETITORS_MIN_ASINS = 2;
|
|
753
1068
|
var DIVE_FROM_COMPETITORS_MAX_ASINS = 200;
|
|
754
|
-
var normalizedAsins =
|
|
1069
|
+
var normalizedAsins = z22.array(z22.string().trim().min(1).toUpperCase()).min(DIVE_FROM_COMPETITORS_MIN_ASINS).max(DIVE_FROM_COMPETITORS_MAX_ASINS).refine((asins) => new Set(asins).size === asins.length, {
|
|
755
1070
|
message: "asins must not contain the same ASIN twice"
|
|
756
1071
|
});
|
|
757
|
-
var
|
|
758
|
-
marketplace:
|
|
1072
|
+
var inputSchema24 = {
|
|
1073
|
+
marketplace: z22.enum(SUPPORTED_MARKETPLACES).describe(
|
|
759
1074
|
"Amazon marketplace where the ASINs are listed. Full domain suffixes: com, ca, co.uk, com.mx, in, fr, de, es, it, co.jp (e.g. UK is `co.uk`, not `uk`)."
|
|
760
1075
|
),
|
|
761
1076
|
asins: normalizedAsins.describe(
|
|
762
1077
|
`The exact competitor ASINs to build the niche from, ${DIVE_FROM_COMPETITORS_MIN_ASINS} to ${DIVE_FROM_COMPETITORS_MAX_ASINS}, each once. No other competitors are added.`
|
|
763
1078
|
),
|
|
764
|
-
confirm:
|
|
1079
|
+
confirm: z22.boolean().optional().describe(
|
|
765
1080
|
"Must be true to proceed \u2014 this dive spends dive tokens for every ASIN. Confirm the cost with the user first."
|
|
766
1081
|
)
|
|
767
1082
|
};
|
|
@@ -769,7 +1084,7 @@ var createNicheDiveFromCompetitorsListTool = {
|
|
|
769
1084
|
name: "create_niche_dive_from_competitors_list",
|
|
770
1085
|
title: "Create a Niche Dive from a Competitor List",
|
|
771
1086
|
description: `Use this when the user already knows which products belong in the niche \u2014 e.g. they list competitor ASINs, or picked them from search results \u2014 and wants niche research on exactly those. Unlike \`create_niche_dive\`, which discovers competitors around one seed ASIN, this builds the niche from the given ASINs only (${DIVE_FROM_COMPETITORS_MIN_ASINS}-${DIVE_FROM_COMPETITORS_MAX_ASINS}). \u26A0\uFE0F Spends dive tokens for every ASIN and cannot be undone \u2014 set \`confirm: true\` only after the user approves the cost. Not safe to retry: each call spends tokens again and starts a separate dive \u2014 if a call errors or times out, poll \`get_dive_status\` (or check \`list_niches\`) instead of re-calling. Fails without spending tokens when the ASIN count is over the plan's limit, when the account is at its niche limit, or when Amazon product data cannot be found for enough of the ASINs. The dive runs asynchronously: this returns a \`diveId\` and an \`estimatedCompletionDate\`; poll \`get_dive_status\` with the \`diveId\` until it reports \`success\`, which carries the new \`nicheId\`.`,
|
|
772
|
-
inputSchema:
|
|
1087
|
+
inputSchema: inputSchema24,
|
|
773
1088
|
// Additive rather than destructive, but flagged destructive so clients prompt before the
|
|
774
1089
|
// irreversible token spend — same reasoning as create_niche_dive. The confirm gate enforces it.
|
|
775
1090
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
@@ -789,23 +1104,23 @@ var createNicheDiveFromCompetitorsListTool = {
|
|
|
789
1104
|
};
|
|
790
1105
|
|
|
791
1106
|
// src/tools/redive-niche.ts
|
|
792
|
-
import { z as
|
|
793
|
-
var
|
|
794
|
-
nicheId:
|
|
795
|
-
mode:
|
|
1107
|
+
import { z as z23 } from "zod";
|
|
1108
|
+
var inputSchema25 = {
|
|
1109
|
+
nicheId: z23.string().min(1).describe("The niche to re-dive. Get one from `list_niches`."),
|
|
1110
|
+
mode: z23.enum(["same_competitors", "discover"]).describe(
|
|
796
1111
|
"How to pick the competitors for the refreshed dive. `same_competitors` re-runs the niche's current competitor set and takes no other argument \u2014 use it to refresh stale data. `discover` searches for a fresh competitor set, which is what you want when the niche has changed."
|
|
797
1112
|
),
|
|
798
|
-
numberOfCompetitors:
|
|
1113
|
+
numberOfCompetitors: z23.number().int().min(2).optional().describe(
|
|
799
1114
|
"Total ASINs the refreshed dive should contain, including `lockedAsins`. Required in `discover` mode and rejected in `same_competitors` mode. Dive tokens are spent per ASIN."
|
|
800
1115
|
),
|
|
801
|
-
heroAsin:
|
|
1116
|
+
heroAsin: z23.string().min(1).optional().describe(
|
|
802
1117
|
"`discover` mode only. Seed product the competitor discovery starts from. Defaults to the niche's highest-selling competitor, preferring one the user's own connected seller account owns."
|
|
803
1118
|
),
|
|
804
|
-
lockedAsins:
|
|
1119
|
+
lockedAsins: z23.array(z23.string().min(1)).optional().describe(
|
|
805
1120
|
"`discover` mode only. ASINs that must stay in the competitor set regardless of what discovery finds. Cannot exceed `numberOfCompetitors`, and cannot overlap `excludedAsins`."
|
|
806
1121
|
),
|
|
807
|
-
excludedAsins:
|
|
808
|
-
confirm:
|
|
1122
|
+
excludedAsins: z23.array(z23.string().min(1)).optional().describe("`discover` mode only. ASINs discovery must never select."),
|
|
1123
|
+
confirm: z23.boolean().optional().describe(
|
|
809
1124
|
"Must be true to proceed \u2014 a re-dive spends dive tokens. Confirm the cost with the user first."
|
|
810
1125
|
)
|
|
811
1126
|
};
|
|
@@ -813,7 +1128,7 @@ var rediveNicheTool = {
|
|
|
813
1128
|
name: "redive_niche",
|
|
814
1129
|
title: "Re-dive an Existing Niche",
|
|
815
1130
|
description: "Use this to refresh an existing niche's research with current Amazon data, instead of creating a new niche with `create_niche_dive`. \u26A0\uFE0F Spends dive tokens (one batch per ASIN dived) and cannot be undone \u2014 set `confirm: true` only after the user approves the cost. Not safe to retry: each call spends tokens again and starts a separate re-dive \u2014 if a call errors or times out, poll `get_dive_status` instead of re-calling. Two modes: `same_competitors` re-dives the niche's current competitor set (no other argument needed) and `discover` finds a fresh set, sized by `numberOfCompetitors` and steerable with `heroAsin` / `lockedAsins` / `excludedAsins`. Runs asynchronously: returns a `diveId` and an `estimatedCompletionDate` \u2014 poll `get_dive_status` with that `diveId` until it reports `success`. The niche keeps its `nicheId`, so existing rank radars and reports follow the refreshed data.",
|
|
816
|
-
inputSchema:
|
|
1131
|
+
inputSchema: inputSchema25,
|
|
817
1132
|
// Same reasoning as create_niche_dive: a re-dive is additive rather than destructive, but the
|
|
818
1133
|
// irreversible token spend is what clients need to prompt on. The confirm gate enforces it regardless.
|
|
819
1134
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
@@ -846,9 +1161,9 @@ var rediveNicheTool = {
|
|
|
846
1161
|
};
|
|
847
1162
|
|
|
848
1163
|
// src/tools/get-dive-status.ts
|
|
849
|
-
import { z as
|
|
850
|
-
var
|
|
851
|
-
diveId:
|
|
1164
|
+
import { z as z24 } from "zod";
|
|
1165
|
+
var inputSchema26 = {
|
|
1166
|
+
diveId: z24.string().min(1).describe(
|
|
852
1167
|
"The dive identifier returned by `create_niche_dive`, `create_niche_dive_from_competitors_list` or `redive_niche`, or the `refresh.diveId` returned by `add_niche_keywords`."
|
|
853
1168
|
)
|
|
854
1169
|
};
|
|
@@ -856,7 +1171,7 @@ var getDiveStatusTool = {
|
|
|
856
1171
|
name: "get_dive_status",
|
|
857
1172
|
title: "Get Niche Dive Status",
|
|
858
1173
|
description: "Use this to poll a niche dive started with `create_niche_dive`, `create_niche_dive_from_competitors_list` or `redive_niche`, or the re-dive `add_niche_keywords` started on a stale niche, until it finishes. Returns one of three shapes keyed by `status`: `in_progress` (with `estimatedCompletionDate`), `success` (with the `nicheId` plus `tokensUsed`/`tokensLeft`), or `error` (with an `error` message). On `success`, use the `nicheId` with `list_niches`, `get_niche_keywords`, `get_niche_competitors`, etc. (for a re-dive it is the same niche you passed in, now carrying refreshed data). Re-poll periodically \u2014 dives can take minutes; the `estimatedCompletionDate` hints at when to check.",
|
|
859
|
-
inputSchema:
|
|
1174
|
+
inputSchema: inputSchema26,
|
|
860
1175
|
annotations: { readOnlyHint: true },
|
|
861
1176
|
handler: async (args, ctx) => {
|
|
862
1177
|
return await httpGet(
|
|
@@ -867,31 +1182,31 @@ var getDiveStatusTool = {
|
|
|
867
1182
|
};
|
|
868
1183
|
|
|
869
1184
|
// src/tools/add-niche-keywords.ts
|
|
870
|
-
import { z as
|
|
1185
|
+
import { z as z26 } from "zod";
|
|
871
1186
|
|
|
872
1187
|
// src/tools/niche-keyword-list.ts
|
|
873
|
-
import { z as
|
|
874
|
-
var nicheKeyword = () =>
|
|
1188
|
+
import { z as z25 } from "zod";
|
|
1189
|
+
var nicheKeyword = () => z25.string().trim().toLowerCase().min(1).max(NICHE_KEYWORD_MAX_LENGTH);
|
|
875
1190
|
function uniqueKeywords(schema, field) {
|
|
876
1191
|
return schema.refine((keywords) => new Set(keywords).size === keywords.length, {
|
|
877
1192
|
message: `${field} must not contain the same keyword twice (compared lower-cased and trimmed)`
|
|
878
1193
|
});
|
|
879
1194
|
}
|
|
880
1195
|
var nicheKeywordList = uniqueKeywords(
|
|
881
|
-
|
|
1196
|
+
z25.array(nicheKeyword()).min(1).max(NICHE_KEYWORDS_MAX_PER_CALL),
|
|
882
1197
|
"keywords"
|
|
883
1198
|
);
|
|
884
1199
|
|
|
885
1200
|
// src/tools/add-niche-keywords.ts
|
|
886
|
-
var
|
|
887
|
-
nicheId:
|
|
1201
|
+
var inputSchema27 = {
|
|
1202
|
+
nicheId: z26.string().min(1).describe("The niche whose Master Keyword List to add to. Get one from `list_niches`."),
|
|
888
1203
|
keywords: nicheKeywordList.describe(
|
|
889
1204
|
`The keywords to add, 1\u2013${NICHE_KEYWORDS_MAX_PER_CALL} per call, at most 255 characters each. They are lower-cased and trimmed, and must be unique after that. Put every keyword in one call: this tool allows only 2 calls per minute per niche.`
|
|
890
1205
|
),
|
|
891
|
-
confirm:
|
|
1206
|
+
confirm: z26.boolean().optional().describe(
|
|
892
1207
|
"Leave unset on the first call. Set to true only after the user approved the Dive token cost from a `confirmation_required` response \u2014 it lets the add re-dive a stale niche."
|
|
893
1208
|
),
|
|
894
|
-
maxTokensUsed:
|
|
1209
|
+
maxTokensUsed: z26.number().int().min(0).optional().describe(
|
|
895
1210
|
"With `confirm: true`: the `tokenCost` the user approved. The call then fails with nothing saved or charged rather than spend more. Ignored without `confirm`, where the tool never spends anything."
|
|
896
1211
|
)
|
|
897
1212
|
};
|
|
@@ -904,7 +1219,7 @@ var addNicheKeywordsTool = {
|
|
|
904
1219
|
name: "add_niche_keywords",
|
|
905
1220
|
title: "Add Keywords to a Niche's Master Keyword List",
|
|
906
1221
|
description: "Use this to add keywords to a niche's Master Keyword List (MKL): the user's own search terms, or keywords from the niche's Outliers or Residue lists. Free while the niche is fresh (dived in the last 24 hours, or a dive is running): the first call adds the keywords at once and they are readable with `get_niche_keywords`. On a stale niche, any keyword new to the niche makes the add re-dive the whole niche with its current competitors, which spends one Dive token per competitor. The first call then saves and spends nothing and returns `confirmation_required` with `tokenCost`; after the user approves, call again with `confirm: true` and `maxTokensUsed` set to that `tokenCost`. Keywords moved in from Outliers or Residue never cost anything. Returns `originBreakdown` (`alreadyInMkl`, `takenFromOutliers`, `takenFromResidue`, `addedManually`) and `tokensUsed`. When `refresh` is present a re-dive is running: poll `get_dive_status` with `refresh.diveId`; the `addedManually` keywords show in the MKL once it succeeds. A confirmed call is not safe to retry: if it errors or times out, poll `get_dive_status` or re-read `get_niche_keywords` instead of re-calling. Limited to 2 calls per minute per niche, so batch keywords into one call. Undo with `remove_niche_keywords`. A keyword hidden by the niche's keyword exclusions stays hidden after an add: check `list_keyword_exclusions` and remove the exclusion with `remove_keyword_exclusions` first.",
|
|
907
|
-
inputSchema:
|
|
1222
|
+
inputSchema: inputSchema27,
|
|
908
1223
|
// Like redive_niche: additive, but it can spend Dive tokens irreversibly, which is what clients
|
|
909
1224
|
// need to prompt on. The confirm gate covers the paid path regardless.
|
|
910
1225
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
@@ -938,9 +1253,9 @@ var addNicheKeywordsTool = {
|
|
|
938
1253
|
};
|
|
939
1254
|
|
|
940
1255
|
// src/tools/remove-niche-keywords.ts
|
|
941
|
-
import { z as
|
|
942
|
-
var
|
|
943
|
-
nicheId:
|
|
1256
|
+
import { z as z27 } from "zod";
|
|
1257
|
+
var inputSchema28 = {
|
|
1258
|
+
nicheId: z27.string().min(1).describe("The niche whose Master Keyword List to remove from. Get one from `list_niches`."),
|
|
944
1259
|
keywords: nicheKeywordList.describe(
|
|
945
1260
|
`The keywords to take out, 1\u2013${NICHE_KEYWORDS_MAX_PER_CALL} per call, at most 255 characters each. They are lower-cased and trimmed, and must be unique after that. Put every keyword in one call: this tool allows only 2 calls per minute per niche.`
|
|
946
1261
|
)
|
|
@@ -949,7 +1264,7 @@ var removeNicheKeywordsTool = {
|
|
|
949
1264
|
name: "remove_niche_keywords",
|
|
950
1265
|
title: "Remove Keywords from a Niche's Master Keyword List",
|
|
951
1266
|
description: "Use this to undo `add_niche_keywords`: take keywords back out of a niche's Master Keyword List (MKL). Only keywords that were added to the MKL can be removed \u2014 `get_niche_keywords` shows each keyword's `origin`. What happens depends on that origin, and the response reports it per keyword: `removedManual` \u2014 added by hand (`manual`), deleted from the niche; `sentBackToOutliers` / `sentBackToResidue` \u2014 moved in from those lists (`outlier` / `residue`), listed there again with their data kept; `notRemovable` \u2014 found by the dive itself (`mkl`) or not in the niche, left unchanged. To hide a keyword the dive found, use `add_keyword_exclusions` instead. Free, and safe to repeat: a keyword already removed comes back under `notRemovable`. Adding a hand-added keyword back later re-dives the niche and costs Dive tokens if the niche is stale by then. Limited to 2 calls per minute per niche.",
|
|
952
|
-
inputSchema:
|
|
1267
|
+
inputSchema: inputSchema28,
|
|
953
1268
|
// Deletes hand-added keywords, and putting them back can cost Dive tokens on a stale niche.
|
|
954
1269
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
955
1270
|
handler: async (args, ctx) => {
|
|
@@ -962,10 +1277,10 @@ var removeNicheKeywordsTool = {
|
|
|
962
1277
|
};
|
|
963
1278
|
|
|
964
1279
|
// src/tools/keyword-exclusions-input.ts
|
|
965
|
-
import { z as
|
|
966
|
-
var entries = (field) => uniqueKeywords(
|
|
1280
|
+
import { z as z28 } from "zod";
|
|
1281
|
+
var entries = (field) => uniqueKeywords(z28.array(nicheKeyword()).max(KEYWORD_EXCLUSIONS_MAX_PER_CALL), field).optional();
|
|
967
1282
|
var keywordExclusionsInputSchema = (verb) => ({
|
|
968
|
-
nicheId:
|
|
1283
|
+
nicheId: z28.string().min(1).describe("The niche whose keyword exclusions to change. Get one from `list_niches`."),
|
|
969
1284
|
exact: entries("exact").describe(
|
|
970
1285
|
`Exact-match entries to ${verb}: each one hides the single keyword that matches it exactly. At most 255 characters each; lower-cased and trimmed, and must be unique after that.`
|
|
971
1286
|
),
|
|
@@ -985,12 +1300,12 @@ function assertExclusionCount(exact, phrase) {
|
|
|
985
1300
|
}
|
|
986
1301
|
|
|
987
1302
|
// src/tools/add-keyword-exclusions.ts
|
|
988
|
-
var
|
|
1303
|
+
var inputSchema29 = keywordExclusionsInputSchema("exclude");
|
|
989
1304
|
var addKeywordExclusionsTool = {
|
|
990
1305
|
name: "add_keyword_exclusions",
|
|
991
1306
|
title: "Exclude Keywords from a Niche",
|
|
992
1307
|
description: `Use this to hide irrelevant keywords from a niche's Master Keyword List \u2014 e.g. other brands, wrong product types. \`exact\` entries hide the one keyword that matches exactly; \`phrase\` entries hide every keyword containing the phrase, so prefer \`exact\` unless the user wants a whole family of keywords gone. The excluded keywords drop out of \`get_niche_keywords\` at once, wherever they come from: the dive, Outliers, Residue, or ones added with \`add_niche_keywords\`. Nothing is deleted: \`remove_keyword_exclusions\` brings them back. Only the exclusions change \u2014 every other niche setting is kept. Send 1\u2013${KEYWORD_EXCLUSIONS_MAX_PER_CALL} entries in total across \`exact\` and \`phrase\`; a niche can hold at most ${KEYWORD_EXCLUSIONS_MAX_PER_NICHE} exclusions. Free, no tokens, and safe to repeat: entries already excluded come back under \`unchanged\`. Returns \`added\`, \`unchanged\` and the full \`exact\` / \`phrase\` lists after the change. Limited to 30 calls per minute per niche, so batch entries into one call.`,
|
|
993
|
-
inputSchema:
|
|
1308
|
+
inputSchema: inputSchema29,
|
|
994
1309
|
// Hides data from every MKL-based view until undone; reversible, but clients should prompt on it.
|
|
995
1310
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
996
1311
|
handler: async (args, ctx) => {
|
|
@@ -1004,12 +1319,12 @@ var addKeywordExclusionsTool = {
|
|
|
1004
1319
|
};
|
|
1005
1320
|
|
|
1006
1321
|
// src/tools/remove-keyword-exclusions.ts
|
|
1007
|
-
var
|
|
1322
|
+
var inputSchema30 = keywordExclusionsInputSchema("stop excluding");
|
|
1008
1323
|
var removeKeywordExclusionsTool = {
|
|
1009
1324
|
name: "remove_keyword_exclusions",
|
|
1010
1325
|
title: "Remove Keyword Exclusions from a Niche",
|
|
1011
1326
|
description: `Use this to undo \`add_keyword_exclusions\`, so the keywords an exclusion hid show in the niche's Master Keyword List (\`get_niche_keywords\`) again. Pass the entries exactly as \`list_keyword_exclusions\` shows them, \`exact\` and \`phrase\` separately: removing a phrase does not touch an exact entry for the same text, and a keyword also hidden by another remaining exclusion stays hidden. Only the exclusions change \u2014 every other niche setting is kept. Send 1\u2013${KEYWORD_EXCLUSIONS_MAX_PER_CALL} entries in total across \`exact\` and \`phrase\`. Free, and safe to repeat: entries that are not excluded come back under \`unchanged\`. Returns \`removed\`, \`unchanged\` and the full \`exact\` / \`phrase\` lists after the change. Limited to 30 calls per minute per niche.`,
|
|
1012
|
-
inputSchema:
|
|
1327
|
+
inputSchema: inputSchema30,
|
|
1013
1328
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1014
1329
|
handler: async (args, ctx) => {
|
|
1015
1330
|
assertExclusionCount(args.exact, args.phrase);
|
|
@@ -1022,10 +1337,10 @@ var removeKeywordExclusionsTool = {
|
|
|
1022
1337
|
};
|
|
1023
1338
|
|
|
1024
1339
|
// src/tools/delete-niche.ts
|
|
1025
|
-
import { z as
|
|
1026
|
-
var
|
|
1027
|
-
nicheId:
|
|
1028
|
-
confirm:
|
|
1340
|
+
import { z as z29 } from "zod";
|
|
1341
|
+
var inputSchema31 = {
|
|
1342
|
+
nicheId: z29.string().min(1).describe("The niche to delete. Get one from `list_niches`."),
|
|
1343
|
+
confirm: z29.boolean().optional().describe(
|
|
1029
1344
|
"Must be true to proceed \u2014 deleting a niche destroys its keywords, competitors and dive history permanently. Confirm with the user first."
|
|
1030
1345
|
)
|
|
1031
1346
|
};
|
|
@@ -1033,7 +1348,7 @@ var deleteNicheTool = {
|
|
|
1033
1348
|
name: "delete_niche",
|
|
1034
1349
|
title: "Delete a Niche",
|
|
1035
1350
|
description: "Use this to permanently remove a niche the user no longer needs. \u26A0\uFE0F Deletes the niche and everything attached to it \u2014 keywords, competitors, all dives and diveboxes \u2014 and cannot be undone; the dive tokens already spent on it are NOT refunded. Set `confirm: true` only after the user approves. A niche used by any Rank Radar cannot be deleted: the call fails with a conflict, so delete or archive those rank radars first (`list_rank_radars` with the `nicheId` filter shows them).",
|
|
1036
|
-
inputSchema:
|
|
1351
|
+
inputSchema: inputSchema31,
|
|
1037
1352
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1038
1353
|
handler: async (args, ctx) => {
|
|
1039
1354
|
const pending = requireConfirmation(
|
|
@@ -1051,15 +1366,15 @@ var deleteNicheTool = {
|
|
|
1051
1366
|
};
|
|
1052
1367
|
|
|
1053
1368
|
// src/tools/pause-rank-radar.ts
|
|
1054
|
-
import { z as
|
|
1055
|
-
var
|
|
1056
|
-
rankRadarId:
|
|
1369
|
+
import { z as z30 } from "zod";
|
|
1370
|
+
var inputSchema32 = {
|
|
1371
|
+
rankRadarId: z30.string().uuid().describe("The Rank Radar UUID to pause (from `list_rank_radars`).")
|
|
1057
1372
|
};
|
|
1058
1373
|
var pauseRankRadarTool = {
|
|
1059
1374
|
name: "pause_rank_radar",
|
|
1060
1375
|
title: "Pause a Rank Radar",
|
|
1061
1376
|
description: "Use this to pause tracking on a Rank Radar without losing anything \u2014 the action the DataDive API calls 'archiving', so when a user asks to archive a Rank Radar, this is the tool they mean. Tracking stops for all of its keywords and the Daily Tracked Keywords quota they held is freed for other Rank Radars, while the Rank Radar and its ranking history are kept. Fully reversible with `resume_rank_radar`, so it needs no `confirm` \u2014 prefer it over `delete_rank_radar` whenever the user may want the data back. Paused Rank Radars show up in `list_rank_radars` under `status: PAUSED` \u2014 not `ARCHIVED`, which covers Rank Radars removed with `delete_rank_radar`. Safe to repeat: pausing an already paused Rank Radar succeeds and changes nothing.",
|
|
1062
|
-
inputSchema:
|
|
1377
|
+
inputSchema: inputSchema32,
|
|
1063
1378
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1064
1379
|
handler: async (args, ctx) => {
|
|
1065
1380
|
await httpPost(
|
|
@@ -1072,15 +1387,15 @@ var pauseRankRadarTool = {
|
|
|
1072
1387
|
};
|
|
1073
1388
|
|
|
1074
1389
|
// src/tools/resume-rank-radar.ts
|
|
1075
|
-
import { z as
|
|
1076
|
-
var
|
|
1077
|
-
rankRadarId:
|
|
1390
|
+
import { z as z31 } from "zod";
|
|
1391
|
+
var inputSchema33 = {
|
|
1392
|
+
rankRadarId: z31.string().uuid().describe("The Rank Radar UUID to resume (from `list_rank_radars`).")
|
|
1078
1393
|
};
|
|
1079
1394
|
var resumeRankRadarTool = {
|
|
1080
1395
|
name: "resume_rank_radar",
|
|
1081
1396
|
title: "Resume a Paused Rank Radar",
|
|
1082
1397
|
description: "Use this to restart tracking on a Rank Radar that was paused with `pause_rank_radar` (shown by `list_rank_radars` under `status: PAUSED`; a deleted, `ARCHIVED` one cannot be resumed). Keywords are resumed as far as the available Daily Tracked Keywords quota allows, most relevant first \u2014 so with a tight quota only part of the original keyword set comes back; check `get_quota` first if that matters. Reversible with `pause_rank_radar`, so it needs no `confirm`. Fails with a bad-request error when there is no quota left at all. Safe to repeat: resuming an already active Rank Radar changes nothing.",
|
|
1083
|
-
inputSchema:
|
|
1398
|
+
inputSchema: inputSchema33,
|
|
1084
1399
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1085
1400
|
handler: async (args, ctx) => {
|
|
1086
1401
|
await httpPost(
|
|
@@ -1093,10 +1408,10 @@ var resumeRankRadarTool = {
|
|
|
1093
1408
|
};
|
|
1094
1409
|
|
|
1095
1410
|
// src/tools/delete-rank-radar.ts
|
|
1096
|
-
import { z as
|
|
1097
|
-
var
|
|
1098
|
-
rankRadarId:
|
|
1099
|
-
confirm:
|
|
1411
|
+
import { z as z32 } from "zod";
|
|
1412
|
+
var inputSchema34 = {
|
|
1413
|
+
rankRadarId: z32.string().uuid().describe("The Rank Radar UUID to delete (from `list_rank_radars`)."),
|
|
1414
|
+
confirm: z32.boolean().optional().describe(
|
|
1100
1415
|
"Must be true to proceed \u2014 deleting a Rank Radar destroys its ranking history permanently. Confirm with the user first."
|
|
1101
1416
|
)
|
|
1102
1417
|
};
|
|
@@ -1104,7 +1419,7 @@ var deleteRankRadarTool = {
|
|
|
1104
1419
|
name: "delete_rank_radar",
|
|
1105
1420
|
title: "Delete a Rank Radar",
|
|
1106
1421
|
description: "Use this to permanently remove a Rank Radar and all of its keyword ranking history. \u26A0\uFE0F Cannot be undone \u2014 there is no restore endpoint; set `confirm: true` only after the user approves. It does free the Daily Tracked Keywords quota those keywords held. Deleted Rank Radars are what `list_rank_radars` returns for `status: ARCHIVED`. If the user only wants to stop tracking for a while and keep the history \u2014 or asks to 'archive' the Rank Radar, which is what the DataDive API calls pausing \u2014 use `pause_rank_radar` instead: it frees the same quota and is reversible with `resume_rank_radar`.",
|
|
1107
|
-
inputSchema:
|
|
1422
|
+
inputSchema: inputSchema34,
|
|
1108
1423
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1109
1424
|
handler: async (args, ctx) => {
|
|
1110
1425
|
const pending = requireConfirmation(
|
|
@@ -1122,10 +1437,10 @@ var deleteRankRadarTool = {
|
|
|
1122
1437
|
};
|
|
1123
1438
|
|
|
1124
1439
|
// src/tools/add-rank-radar-search-terms.ts
|
|
1125
|
-
import { z as
|
|
1126
|
-
var
|
|
1127
|
-
rankRadarId:
|
|
1128
|
-
searchTerms:
|
|
1440
|
+
import { z as z33 } from "zod";
|
|
1441
|
+
var inputSchema35 = {
|
|
1442
|
+
rankRadarId: z33.string().uuid().describe("The Rank Radar UUID to add the search terms to (from `list_rank_radars`)."),
|
|
1443
|
+
searchTerms: z33.array(z33.string().min(1)).min(1).max(ADD_SEARCH_TERMS_MAX).describe(
|
|
1129
1444
|
`The keywords to start tracking, 1\u2013${ADD_SEARCH_TERMS_MAX} per call. Must be unique. Amazon-ignored special characters (@, #, _, parentheses, \u2026) are rejected.`
|
|
1130
1445
|
)
|
|
1131
1446
|
};
|
|
@@ -1133,7 +1448,7 @@ var addRankRadarSearchTermsTool = {
|
|
|
1133
1448
|
name: "add_rank_radar_search_terms",
|
|
1134
1449
|
title: "Add Search Terms to a Rank Radar",
|
|
1135
1450
|
description: "Use this to start tracking extra keywords on an existing Rank Radar, instead of creating a new one with `create_rank_radar`. New keywords are added to the niche and tracked from now on; any matching keyword that was previously paused is resumed. Each newly tracked keyword takes one Daily Tracked Keywords slot, and the call fails if the quota is exhausted \u2014 check `get_quota` first. Reversible with `pause_rank_radar_search_terms`, which frees the slots again, so it needs no `confirm`. Returns `originBreakdown` (where each submitted term ended up) and `keywordToRankRadarKeywordIdMap`, whose ids are what the pause/resume search-term tools take.",
|
|
1136
|
-
inputSchema:
|
|
1451
|
+
inputSchema: inputSchema35,
|
|
1137
1452
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1138
1453
|
handler: async (args, ctx) => {
|
|
1139
1454
|
return await httpPost(
|
|
@@ -1145,10 +1460,10 @@ var addRankRadarSearchTermsTool = {
|
|
|
1145
1460
|
};
|
|
1146
1461
|
|
|
1147
1462
|
// src/tools/pause-rank-radar-search-terms.ts
|
|
1148
|
-
import { z as
|
|
1149
|
-
var
|
|
1150
|
-
rankRadarId:
|
|
1151
|
-
rankRadarKeywordIds:
|
|
1463
|
+
import { z as z34 } from "zod";
|
|
1464
|
+
var inputSchema36 = {
|
|
1465
|
+
rankRadarId: z34.string().uuid().describe("The Rank Radar UUID the search terms belong to."),
|
|
1466
|
+
rankRadarKeywordIds: z34.array(z34.string().uuid()).min(1).describe(
|
|
1152
1467
|
"The Rank Radar keyword ids to pause. These are the `id` values from `get_rank_radar_data`, or the values of `keywordToRankRadarKeywordIdMap` returned by `add_rank_radar_search_terms` \u2014 not the keyword text."
|
|
1153
1468
|
)
|
|
1154
1469
|
};
|
|
@@ -1156,7 +1471,7 @@ var pauseRankRadarSearchTermsTool = {
|
|
|
1156
1471
|
name: "pause_rank_radar_search_terms",
|
|
1157
1472
|
title: "Pause Search Terms of a Rank Radar",
|
|
1158
1473
|
description: "Use this to stop tracking individual keywords on a Rank Radar while keeping the Rank Radar itself active \u2014 the way to trim a keyword set the user finds too broad. The DataDive API calls this 'archiving' the search terms; nothing is lost. The paused keywords keep their history and their Daily Tracked Keywords slots are freed for other keywords. Reversible with `resume_rank_radar_search_terms`, so it needs no `confirm`. Takes keyword ids, not keyword text: get them from `get_rank_radar_data`. Safe to repeat: already-paused terms are left unchanged.",
|
|
1159
|
-
inputSchema:
|
|
1474
|
+
inputSchema: inputSchema36,
|
|
1160
1475
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1161
1476
|
handler: async (args, ctx) => {
|
|
1162
1477
|
await httpPost(
|
|
@@ -1173,10 +1488,10 @@ var pauseRankRadarSearchTermsTool = {
|
|
|
1173
1488
|
};
|
|
1174
1489
|
|
|
1175
1490
|
// src/tools/resume-rank-radar-search-terms.ts
|
|
1176
|
-
import { z as
|
|
1177
|
-
var
|
|
1178
|
-
rankRadarId:
|
|
1179
|
-
rankRadarKeywordIds:
|
|
1491
|
+
import { z as z35 } from "zod";
|
|
1492
|
+
var inputSchema37 = {
|
|
1493
|
+
rankRadarId: z35.string().uuid().describe("The Rank Radar UUID the search terms belong to."),
|
|
1494
|
+
rankRadarKeywordIds: z35.array(z35.string().uuid()).min(1).describe(
|
|
1180
1495
|
"The Rank Radar keyword ids to resume. These are the `id` values from `get_rank_radar_data`, or the values of `keywordToRankRadarKeywordIdMap` returned by `add_rank_radar_search_terms` \u2014 not the keyword text."
|
|
1181
1496
|
)
|
|
1182
1497
|
};
|
|
@@ -1184,7 +1499,7 @@ var resumeRankRadarSearchTermsTool = {
|
|
|
1184
1499
|
name: "resume_rank_radar_search_terms",
|
|
1185
1500
|
title: "Resume Paused Search Terms of a Rank Radar",
|
|
1186
1501
|
description: "Use this to start tracking keywords again that were paused with `pause_rank_radar_search_terms`. Each resumed keyword takes back one Daily Tracked Keywords slot, and the call fails if the quota is exhausted \u2014 check `get_quota` first. Reversible with `pause_rank_radar_search_terms`, so it needs no `confirm`. Takes keyword ids, not keyword text: get them from `get_rank_radar_data`. Safe to repeat: already-active terms are left unchanged.",
|
|
1187
|
-
inputSchema:
|
|
1502
|
+
inputSchema: inputSchema37,
|
|
1188
1503
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1189
1504
|
handler: async (args, ctx) => {
|
|
1190
1505
|
await httpPost(
|
|
@@ -1201,18 +1516,18 @@ var resumeRankRadarSearchTermsTool = {
|
|
|
1201
1516
|
};
|
|
1202
1517
|
|
|
1203
1518
|
// src/tools/list-rank-radar-tags.ts
|
|
1204
|
-
import { z as
|
|
1519
|
+
import { z as z36 } from "zod";
|
|
1205
1520
|
var LIST_RANK_RADAR_TAGS_MAX_PAGE_SIZE = 50;
|
|
1206
|
-
var
|
|
1207
|
-
rankRadarId:
|
|
1208
|
-
currentPage:
|
|
1209
|
-
pageSize:
|
|
1521
|
+
var inputSchema38 = {
|
|
1522
|
+
rankRadarId: z36.string().uuid().describe("The Rank Radar UUID whose tags to list (from `list_rank_radars`)."),
|
|
1523
|
+
currentPage: z36.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
1524
|
+
pageSize: z36.number().int().min(1).max(LIST_RANK_RADAR_TAGS_MAX_PAGE_SIZE).optional().describe(`Items per page (max ${LIST_RANK_RADAR_TAGS_MAX_PAGE_SIZE}). Defaults to 20.`)
|
|
1210
1525
|
};
|
|
1211
1526
|
var listRankRadarTagsTool = {
|
|
1212
1527
|
name: "list_rank_radar_tags",
|
|
1213
1528
|
title: "List Tags of a Rank Radar",
|
|
1214
1529
|
description: `Use this to find a \`tagId\` before calling \`update_rank_radar_tag\`, \`delete_rank_radar_tag\`, \`add_rank_radar_tag_search_terms\` or \`remove_rank_radar_tag_search_terms\`. Returns the user tags ("highlights") on the specified Rank Radar, ordered by title (case-insensitive, ascending). Each row carries \`id\`, \`title\`, \`color\`, \`description\`, \`startAt\`, \`endAt\`, \`createdAt\`, and \`keywordCount\` \u2014 the number of Rank Radar keywords this tag is applied to. The system "paused" tag (the one the quota pauser writes with a reserved colour) is not listed and cannot be addressed from these tools. Supports pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev); a page holds at most ${LIST_RANK_RADAR_TAGS_MAX_PAGE_SIZE} tags.`,
|
|
1215
|
-
inputSchema:
|
|
1530
|
+
inputSchema: inputSchema38,
|
|
1216
1531
|
annotations: { readOnlyHint: true },
|
|
1217
1532
|
handler: async (args, ctx) => {
|
|
1218
1533
|
return await httpGet(
|
|
@@ -1227,19 +1542,19 @@ var listRankRadarTagsTool = {
|
|
|
1227
1542
|
};
|
|
1228
1543
|
|
|
1229
1544
|
// src/tools/create-rank-radar-tag.ts
|
|
1230
|
-
import { z as
|
|
1231
|
-
var
|
|
1232
|
-
rankRadarId:
|
|
1233
|
-
title:
|
|
1545
|
+
import { z as z37 } from "zod";
|
|
1546
|
+
var inputSchema39 = {
|
|
1547
|
+
rankRadarId: z37.string().uuid().describe("The Rank Radar UUID to create the tag on (from `list_rank_radars`)."),
|
|
1548
|
+
title: z37.string().min(1).max(TAG_TITLE_MAX_LENGTH).describe(
|
|
1234
1549
|
`Display title (1\u2013${TAG_TITLE_MAX_LENGTH} characters, trimmed on write). Must be unique on this Rank Radar, case-insensitive. A clash returns 409 with \`{ error: 'TAG_TITLE_EXISTS', existingTagId }\` \u2014 reuse that id instead of retrying.`
|
|
1235
1550
|
),
|
|
1236
|
-
color:
|
|
1551
|
+
color: z37.string().regex(TAG_HEX_COLOR_PATTERN, "color must be in #RRGGBB form").optional().describe(
|
|
1237
1552
|
`Hex colour in \`#RRGGBB\` form. Defaults to the UI grey when omitted. The reserved colour \`${TAG_RESERVED_COLOR}\` (used by the system "paused" tag) is rejected with 400.`
|
|
1238
1553
|
),
|
|
1239
|
-
description:
|
|
1240
|
-
startAt:
|
|
1241
|
-
endAt:
|
|
1242
|
-
rankRadarKeywordIds:
|
|
1554
|
+
description: z37.string().optional().describe("Free-form description, e.g. 'Prime Day run-up'."),
|
|
1555
|
+
startAt: z37.string().optional().describe("ISO 8601 start date, e.g. '2026-07-01'. Required if `endAt` is set; `endAt >= startAt`."),
|
|
1556
|
+
endAt: z37.string().optional().describe("ISO 8601 end date, e.g. '2026-07-14'. Must be greater than or equal to `startAt`."),
|
|
1557
|
+
rankRadarKeywordIds: z37.array(z37.string().uuid()).min(1).max(TAG_KEYWORD_IDS_MAX).optional().describe(
|
|
1243
1558
|
`Optional: Rank Radar keyword ids to tag on creation (1\u2013${TAG_KEYWORD_IDS_MAX}). These are the \`id\` values from \`get_rank_radar_data\`; the ids must all belong to this Rank Radar. To attach more later, use \`add_rank_radar_tag_search_terms\`.`
|
|
1244
1559
|
)
|
|
1245
1560
|
};
|
|
@@ -1247,7 +1562,7 @@ var createRankRadarTagTool = {
|
|
|
1247
1562
|
name: "create_rank_radar_tag",
|
|
1248
1563
|
title: "Create a Rank Radar Tag",
|
|
1249
1564
|
description: `Use this to create a new user tag ("highlight") on a Rank Radar \u2014 the way the UI marks a window on the ranking chart. Writing a tag costs nothing and is reversible with \`delete_rank_radar_tag\`, so no confirmation is required. Returns the new tag row (\`id\`, \`title\`, \`color\`, \`description\`, \`startAt\`, \`endAt\`, \`keywordCount\`, \`createdAt\`); the \`id\` is the \`tagId\` the other tag tools take. If the title clashes with an existing tag on this Rank Radar, the API answers 409 \`{ error: 'TAG_TITLE_EXISTS', existingTagId }\` so callers can reuse the existing tag without a follow-up \`list_rank_radar_tags\`. The reserved colour \`${TAG_RESERVED_COLOR}\` is rejected with 400. Pass \`rankRadarKeywordIds\` to tag a batch of keywords in the same call; otherwise create the tag and attach keywords later with \`add_rank_radar_tag_search_terms\`.`,
|
|
1250
|
-
inputSchema:
|
|
1565
|
+
inputSchema: inputSchema39,
|
|
1251
1566
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1252
1567
|
handler: async (args, ctx) => {
|
|
1253
1568
|
const body = { title: args.title };
|
|
@@ -1265,23 +1580,23 @@ var createRankRadarTagTool = {
|
|
|
1265
1580
|
};
|
|
1266
1581
|
|
|
1267
1582
|
// src/tools/update-rank-radar-tag.ts
|
|
1268
|
-
import { z as
|
|
1269
|
-
var
|
|
1270
|
-
rankRadarId:
|
|
1271
|
-
tagId:
|
|
1272
|
-
title:
|
|
1583
|
+
import { z as z38 } from "zod";
|
|
1584
|
+
var inputSchema40 = {
|
|
1585
|
+
rankRadarId: z38.string().uuid().describe("The Rank Radar UUID the tag belongs to (from `list_rank_radars`)."),
|
|
1586
|
+
tagId: z38.string().uuid().describe("The tag UUID to update (the `id` from `list_rank_radar_tags` or `create_rank_radar_tag`)."),
|
|
1587
|
+
title: z38.string().min(1).max(TAG_TITLE_MAX_LENGTH).optional().describe(
|
|
1273
1588
|
`New title (1\u2013${TAG_TITLE_MAX_LENGTH} characters, trimmed on write). Must be unique on this Rank Radar, case-insensitive. A clash returns 409 with \`{ error: 'TAG_TITLE_EXISTS', existingTagId }\`.`
|
|
1274
1589
|
),
|
|
1275
|
-
color:
|
|
1276
|
-
description:
|
|
1277
|
-
startAt:
|
|
1278
|
-
endAt:
|
|
1590
|
+
color: z38.string().regex(TAG_HEX_COLOR_PATTERN, "color must be in #RRGGBB form").optional().describe(`Hex colour in \`#RRGGBB\` form. The reserved colour \`${TAG_RESERVED_COLOR}\` is rejected with 400.`),
|
|
1591
|
+
description: z38.string().optional().describe("Free-form description. Pass an empty string to clear."),
|
|
1592
|
+
startAt: z38.string().optional().describe("ISO 8601 start date, e.g. '2026-07-01'. `endAt >= startAt`."),
|
|
1593
|
+
endAt: z38.string().optional().describe("ISO 8601 end date, e.g. '2026-07-14'. `endAt >= startAt`.")
|
|
1279
1594
|
};
|
|
1280
1595
|
var updateRankRadarTagTool = {
|
|
1281
1596
|
name: "update_rank_radar_tag",
|
|
1282
1597
|
title: "Update a Rank Radar Tag",
|
|
1283
1598
|
description: "Use this to change a tag's title, colour, description, or date window. Partial update: only the fields you pass are modified, the rest are left as they are. The system \"paused\" tag (reserved colour, written by the quota pauser) cannot be addressed from here \u2014 the API answers 404. Writing a tag costs nothing and is reversible, so no confirmation is required. Returns the updated tag row. Title clashes return 409 `{ error: 'TAG_TITLE_EXISTS', existingTagId }`; the reserved colour returns 400; and `endAt < startAt` returns 400 (for whichever side the body omits, the comparison uses the stored value).",
|
|
1284
|
-
inputSchema:
|
|
1599
|
+
inputSchema: inputSchema40,
|
|
1285
1600
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1286
1601
|
handler: async (args, ctx) => {
|
|
1287
1602
|
const body = {};
|
|
@@ -1299,11 +1614,11 @@ var updateRankRadarTagTool = {
|
|
|
1299
1614
|
};
|
|
1300
1615
|
|
|
1301
1616
|
// src/tools/delete-rank-radar-tag.ts
|
|
1302
|
-
import { z as
|
|
1303
|
-
var
|
|
1304
|
-
rankRadarId:
|
|
1305
|
-
tagId:
|
|
1306
|
-
confirm:
|
|
1617
|
+
import { z as z39 } from "zod";
|
|
1618
|
+
var inputSchema41 = {
|
|
1619
|
+
rankRadarId: z39.string().uuid().describe("The Rank Radar UUID the tag belongs to (from `list_rank_radars`)."),
|
|
1620
|
+
tagId: z39.string().uuid().describe("The tag UUID to delete (the `id` from `list_rank_radar_tags`)."),
|
|
1621
|
+
confirm: z39.boolean().optional().describe(
|
|
1307
1622
|
"Must be true to proceed. Confirm with the user first \u2014 the tag's keyword assignments are removed too and the tag cannot be recovered."
|
|
1308
1623
|
)
|
|
1309
1624
|
};
|
|
@@ -1311,7 +1626,7 @@ var deleteRankRadarTagTool = {
|
|
|
1311
1626
|
name: "delete_rank_radar_tag",
|
|
1312
1627
|
title: "Delete a Rank Radar Tag",
|
|
1313
1628
|
description: 'Use this to permanently remove a tag from a Rank Radar. \u26A0\uFE0F The tag itself is gone and the assignments linking it to each tagged keyword are removed with it; the keywords themselves keep tracking. The deletion cannot be undone from this tool, so set `confirm: true` only after the user approves. The system "paused" tag (reserved colour, written by the quota pauser) cannot be addressed from here \u2014 the API answers 404. To remove just the assignments and keep the tag, use `remove_rank_radar_tag_search_terms` instead.',
|
|
1314
|
-
inputSchema:
|
|
1629
|
+
inputSchema: inputSchema41,
|
|
1315
1630
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1316
1631
|
handler: async (args, ctx) => {
|
|
1317
1632
|
const pending = requireConfirmation(
|
|
@@ -1329,11 +1644,11 @@ var deleteRankRadarTagTool = {
|
|
|
1329
1644
|
};
|
|
1330
1645
|
|
|
1331
1646
|
// src/tools/add-rank-radar-tag-search-terms.ts
|
|
1332
|
-
import { z as
|
|
1333
|
-
var
|
|
1334
|
-
rankRadarId:
|
|
1335
|
-
tagId:
|
|
1336
|
-
rankRadarKeywordIds:
|
|
1647
|
+
import { z as z40 } from "zod";
|
|
1648
|
+
var inputSchema42 = {
|
|
1649
|
+
rankRadarId: z40.string().uuid().describe("The Rank Radar UUID the tag belongs to (from `list_rank_radars`)."),
|
|
1650
|
+
tagId: z40.string().uuid().describe("The tag UUID to attach keywords to (the `id` from `list_rank_radar_tags`)."),
|
|
1651
|
+
rankRadarKeywordIds: z40.array(z40.string().uuid()).min(1).max(TAG_KEYWORD_IDS_MAX).describe(
|
|
1337
1652
|
`Rank Radar keyword ids to attach to this tag (1\u2013${TAG_KEYWORD_IDS_MAX} per call, unique). These are the \`id\` values from \`get_rank_radar_data\`; all ids must belong to this Rank Radar. Safe to repeat: keywords already attached are left unchanged.`
|
|
1338
1653
|
)
|
|
1339
1654
|
};
|
|
@@ -1341,7 +1656,7 @@ var addRankRadarTagSearchTermsTool = {
|
|
|
1341
1656
|
name: "add_rank_radar_tag_search_terms",
|
|
1342
1657
|
title: "Attach Search Terms to a Rank Radar Tag",
|
|
1343
1658
|
description: `Use this to tag a batch of keywords on a Rank Radar \u2014 the same relation \`create_rank_radar_tag\` writes when \`rankRadarKeywordIds\` is passed on creation, so this is how you keep extending a tag's keyword set over time. Reversible with \`remove_rank_radar_tag_search_terms\`, so no confirmation is required. Idempotent: already-attached keywords are left unchanged, so re-sending the same ids after a timeout is safe. Up to ${TAG_KEYWORD_IDS_MAX} ids per call \u2014 split larger batches into multiple calls. The system "paused" tag (reserved colour, written by the quota pauser) is not addressable: the API answers 404.`,
|
|
1344
|
-
inputSchema:
|
|
1659
|
+
inputSchema: inputSchema42,
|
|
1345
1660
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1346
1661
|
handler: async (args, ctx) => {
|
|
1347
1662
|
return await httpPost(
|
|
@@ -1353,11 +1668,11 @@ var addRankRadarTagSearchTermsTool = {
|
|
|
1353
1668
|
};
|
|
1354
1669
|
|
|
1355
1670
|
// src/tools/remove-rank-radar-tag-search-terms.ts
|
|
1356
|
-
import { z as
|
|
1357
|
-
var
|
|
1358
|
-
rankRadarId:
|
|
1359
|
-
tagId:
|
|
1360
|
-
rankRadarKeywordIds:
|
|
1671
|
+
import { z as z41 } from "zod";
|
|
1672
|
+
var inputSchema43 = {
|
|
1673
|
+
rankRadarId: z41.string().uuid().describe("The Rank Radar UUID the tag belongs to (from `list_rank_radars`)."),
|
|
1674
|
+
tagId: z41.string().uuid().describe("The tag UUID to detach keywords from (the `id` from `list_rank_radar_tags`)."),
|
|
1675
|
+
rankRadarKeywordIds: z41.array(z41.string().uuid()).min(1).max(TAG_KEYWORD_IDS_MAX).describe(
|
|
1361
1676
|
`Rank Radar keyword ids to detach from this tag (1\u2013${TAG_KEYWORD_IDS_MAX} per call, unique). These are the \`id\` values from \`get_rank_radar_data\`. Safe to repeat: keywords that are not currently attached are left unchanged.`
|
|
1362
1677
|
)
|
|
1363
1678
|
};
|
|
@@ -1365,7 +1680,7 @@ var removeRankRadarTagSearchTermsTool = {
|
|
|
1365
1680
|
name: "remove_rank_radar_tag_search_terms",
|
|
1366
1681
|
title: "Detach Search Terms from a Rank Radar Tag",
|
|
1367
1682
|
description: `Use this to remove keywords from a tag without deleting the tag itself. The tag keeps its title, colour and date window; only the keyword assignments listed are cleared. Reversible with \`add_rank_radar_tag_search_terms\`, so no confirmation is required. Idempotent: ids that are not currently attached are left unchanged, so re-sending the same ids after a timeout is safe. Up to ${TAG_KEYWORD_IDS_MAX} ids per call \u2014 split larger batches into multiple calls. To remove the tag itself, use \`delete_rank_radar_tag\`. The system "paused" tag (reserved colour, written by the quota pauser) is not addressable: the API answers 404.`,
|
|
1368
|
-
inputSchema:
|
|
1683
|
+
inputSchema: inputSchema43,
|
|
1369
1684
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1370
1685
|
handler: async (args, ctx) => {
|
|
1371
1686
|
return await httpPost(
|
|
@@ -1377,16 +1692,16 @@ var removeRankRadarTagSearchTermsTool = {
|
|
|
1377
1692
|
};
|
|
1378
1693
|
|
|
1379
1694
|
// src/tools/generate-listing-copy.ts
|
|
1380
|
-
import { z as
|
|
1381
|
-
var
|
|
1382
|
-
nicheId:
|
|
1383
|
-
strategy:
|
|
1695
|
+
import { z as z42 } from "zod";
|
|
1696
|
+
var inputSchema44 = {
|
|
1697
|
+
nicheId: z42.string().min(1).describe("The niche whose keyword data the copy is written from. Get one from `list_niches`."),
|
|
1698
|
+
strategy: z42.enum(LISTING_COPY_STRATEGIES).describe(
|
|
1384
1699
|
"Which generation strategy to use. `cosmo` targets Amazon's COSMO relevance model, `ranking-juice` optimises for DataDive's ranking-juice score, `nlp` writes for keyword coverage, and `cosmo-rufus` targets COSMO plus the Rufus shopping assistant. Ask the user if they have no preference."
|
|
1385
1700
|
),
|
|
1386
|
-
currentListing:
|
|
1701
|
+
currentListing: z42.record(z42.union([z42.string(), z42.array(z42.string())])).describe(
|
|
1387
1702
|
'The seller\'s existing listing to rewrite, as an object \u2014 e.g. `{ "title": "...", "description": "...", "bullets": ["...", "..."] }`. Pass what the user has; it is the starting point the generated copy builds on.'
|
|
1388
1703
|
),
|
|
1389
|
-
confirm:
|
|
1704
|
+
confirm: z42.boolean().optional().describe(
|
|
1390
1705
|
"Must be true to proceed \u2014 each generation spends one AI Copywriter prompt from the quota. Confirm the cost with the user first."
|
|
1391
1706
|
)
|
|
1392
1707
|
};
|
|
@@ -1394,7 +1709,7 @@ var generateListingCopyTool = {
|
|
|
1394
1709
|
name: "generate_listing_copy",
|
|
1395
1710
|
title: "Generate Listing Copy for a Niche",
|
|
1396
1711
|
description: "Use this to draft an optimised Amazon listing \u2014 title, bullets and description \u2014 from a niche's keyword research and the seller's current listing. It writes text only: nothing is published to Amazon, and the user still has to paste the result into Seller Central. \u26A0\uFE0F Spends one AI Copywriter prompt from the quota per call and cannot be undone \u2014 set `confirm: true` only after the user approves. Not safe to retry: each call spends another prompt, so if a call errors or times out, poll `get_listing_copy_generation_status` instead of re-calling. Runs asynchronously: returns a `generationId` \u2014 poll `get_listing_copy_generation_status` with it until the status is `complete`.",
|
|
1397
|
-
inputSchema:
|
|
1712
|
+
inputSchema: inputSchema44,
|
|
1398
1713
|
annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: false },
|
|
1399
1714
|
handler: async (args, ctx) => {
|
|
1400
1715
|
const pending = requireConfirmation(
|
|
@@ -1412,16 +1727,16 @@ var generateListingCopyTool = {
|
|
|
1412
1727
|
};
|
|
1413
1728
|
|
|
1414
1729
|
// src/tools/get-listing-copy-generation-status.ts
|
|
1415
|
-
import { z as
|
|
1416
|
-
var
|
|
1417
|
-
nicheId:
|
|
1418
|
-
generationId:
|
|
1730
|
+
import { z as z43 } from "zod";
|
|
1731
|
+
var inputSchema45 = {
|
|
1732
|
+
nicheId: z43.string().min(1).describe("The niche the generation was started for."),
|
|
1733
|
+
generationId: z43.string().min(1).describe("The `generationId` returned by `generate_listing_copy`.")
|
|
1419
1734
|
};
|
|
1420
1735
|
var getListingCopyGenerationStatusTool = {
|
|
1421
1736
|
name: "get_listing_copy_generation_status",
|
|
1422
1737
|
title: "Get Listing Copy Generation Status",
|
|
1423
1738
|
description: "Use this to poll a listing-copy draft started with `generate_listing_copy` until it finishes. Returns one of three shapes keyed by `status`: `generating` (still running \u2014 poll again in a few seconds), `complete` (with `result`, carrying the generated `title`, `bullets`, `description`, `itemHighlights` and its `rankingJuice` score), or `failed` (with an `error` message). Polling is free \u2014 it does not spend another AI Copywriter prompt, so always poll rather than re-calling `generate_listing_copy`.",
|
|
1424
|
-
inputSchema:
|
|
1739
|
+
inputSchema: inputSchema45,
|
|
1425
1740
|
annotations: { readOnlyHint: true },
|
|
1426
1741
|
handler: async (args, ctx) => {
|
|
1427
1742
|
return await httpGet(
|
|
@@ -1432,16 +1747,16 @@ var getListingCopyGenerationStatusTool = {
|
|
|
1432
1747
|
};
|
|
1433
1748
|
|
|
1434
1749
|
// src/tools/list-seller-profiles.ts
|
|
1435
|
-
import { z as
|
|
1436
|
-
var
|
|
1437
|
-
currentPage:
|
|
1438
|
-
pageSize:
|
|
1750
|
+
import { z as z44 } from "zod";
|
|
1751
|
+
var inputSchema46 = {
|
|
1752
|
+
currentPage: z44.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
1753
|
+
pageSize: z44.number().int().min(1).max(50).optional().describe("Items per page (max 50). Defaults to 20.")
|
|
1439
1754
|
};
|
|
1440
1755
|
var listSellerProfilesTool = {
|
|
1441
1756
|
name: "list_seller_profiles",
|
|
1442
1757
|
title: "List Connected Amazon Seller Profiles",
|
|
1443
1758
|
description: 'Use this when the user asks which Amazon seller accounts are connected, or as the discovery step to find the `sellerId` and `marketplace` required by `get_asin_inventory_distribution`, `get_seller_catalog`, `get_seller_listing_changes`, and the alert tools. Returns a paginated list of the organization\'s connected seller profiles \u2014 each item has sellerId, sellerName, marketplace (e.g. "com", "co.uk"), hasAdApi (whether Advertising API credentials are connected), and createdAt \u2014 plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev).',
|
|
1444
|
-
inputSchema:
|
|
1759
|
+
inputSchema: inputSchema46,
|
|
1445
1760
|
annotations: { readOnlyHint: true },
|
|
1446
1761
|
handler: async (args, ctx) => {
|
|
1447
1762
|
return await httpGet(
|
|
@@ -1456,15 +1771,15 @@ var listSellerProfilesTool = {
|
|
|
1456
1771
|
};
|
|
1457
1772
|
|
|
1458
1773
|
// src/tools/get-seller-catalog.ts
|
|
1459
|
-
import { z as
|
|
1774
|
+
import { z as z46 } from "zod";
|
|
1460
1775
|
|
|
1461
1776
|
// src/tools/seller-scoped.ts
|
|
1462
|
-
import { z as
|
|
1777
|
+
import { z as z45 } from "zod";
|
|
1463
1778
|
var sellerScopedInputSchema = {
|
|
1464
|
-
sellerId:
|
|
1779
|
+
sellerId: z45.string().min(1).describe(
|
|
1465
1780
|
"Amazon seller account ID. Get it from `list_seller_profiles`, or find it on the Connections page at https://2.datadive.tools."
|
|
1466
1781
|
),
|
|
1467
|
-
marketplace:
|
|
1782
|
+
marketplace: z45.enum(SUPPORTED_MARKETPLACES).describe('Amazon marketplace code, e.g. "com" for amazon.com or "co.uk" for amazon.co.uk.')
|
|
1468
1783
|
};
|
|
1469
1784
|
function sellerMarketplacePath(sellerId, marketplace, suffix) {
|
|
1470
1785
|
return `/v1/seller_profiles/${encodeURIComponent(sellerId)}/marketplaces/${encodeURIComponent(
|
|
@@ -1473,19 +1788,19 @@ function sellerMarketplacePath(sellerId, marketplace, suffix) {
|
|
|
1473
1788
|
}
|
|
1474
1789
|
|
|
1475
1790
|
// src/tools/get-seller-catalog.ts
|
|
1476
|
-
var
|
|
1791
|
+
var inputSchema47 = {
|
|
1477
1792
|
...sellerScopedInputSchema,
|
|
1478
|
-
search:
|
|
1479
|
-
brand:
|
|
1480
|
-
status:
|
|
1481
|
-
currentPage:
|
|
1482
|
-
pageSize:
|
|
1793
|
+
search: z46.string().min(1).optional().describe("Case-insensitive partial match on product title or brand."),
|
|
1794
|
+
brand: z46.string().min(1).optional().describe("Case-insensitive partial match on brand name."),
|
|
1795
|
+
status: z46.enum(CATALOG_STATUSES).optional().describe('Listing status filter. "Active" (default) or "all".'),
|
|
1796
|
+
currentPage: z46.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
1797
|
+
pageSize: z46.number().int().min(1).max(50).optional().describe("Items per page (max 50). Defaults to 20.")
|
|
1483
1798
|
};
|
|
1484
1799
|
var getSellerCatalogTool = {
|
|
1485
1800
|
name: "get_seller_catalog",
|
|
1486
1801
|
title: "List Catalog ASINs for a Seller",
|
|
1487
1802
|
description: "Use this when the user wants to browse or search a seller's own Amazon catalog \u2014 the products they sell on a given marketplace. Requires a `sellerId` + `marketplace` (use `list_seller_profiles` to discover them). Filter by `search` (title/brand), `brand`, and `status` (Active by default, or all). Returns a paginated list where each item has asin, title, parentAsin, brand, status, imageUrl, and hasVariations, plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev).",
|
|
1488
|
-
inputSchema:
|
|
1803
|
+
inputSchema: inputSchema47,
|
|
1489
1804
|
annotations: { readOnlyHint: true },
|
|
1490
1805
|
handler: async (args, ctx) => {
|
|
1491
1806
|
return await httpGet(
|
|
@@ -1503,28 +1818,28 @@ var getSellerCatalogTool = {
|
|
|
1503
1818
|
};
|
|
1504
1819
|
|
|
1505
1820
|
// src/tools/get-seller-listing-changes.ts
|
|
1506
|
-
import { z as
|
|
1507
|
-
var
|
|
1821
|
+
import { z as z47 } from "zod";
|
|
1822
|
+
var inputSchema48 = {
|
|
1508
1823
|
...sellerScopedInputSchema,
|
|
1509
|
-
types:
|
|
1510
|
-
asin:
|
|
1511
|
-
brand:
|
|
1512
|
-
search:
|
|
1513
|
-
startDate:
|
|
1514
|
-
endDate:
|
|
1515
|
-
sortBy:
|
|
1516
|
-
sortOrder:
|
|
1517
|
-
includeCorrelations:
|
|
1824
|
+
types: z47.array(z47.enum(LISTING_CHANGE_TYPES)).min(1).optional().describe('Filter to specific change types. Omit for all. Any of "Price", "Content", "Image".'),
|
|
1825
|
+
asin: z47.string().min(1).optional().describe("Filter to an exact ASIN or parent ASIN."),
|
|
1826
|
+
brand: z47.string().min(1).optional().describe("Case-insensitive partial match on brand name."),
|
|
1827
|
+
search: z47.string().min(1).optional().describe("Case-insensitive partial match on product title or brand."),
|
|
1828
|
+
startDate: z47.string().regex(ISO_8601, "startDate must be an ISO-8601 date or timestamp (e.g. 2026-05-01 or 2026-05-01T00:00:00Z)").optional().describe("ISO-8601 date/timestamp; return only changes detected on or after this time."),
|
|
1829
|
+
endDate: z47.string().regex(ISO_8601, "endDate must be an ISO-8601 date or timestamp (e.g. 2026-05-31 or 2026-05-31T23:59:59Z)").optional().describe("ISO-8601 date/timestamp; return only changes detected on or before this time."),
|
|
1830
|
+
sortBy: z47.enum(LISTING_CHANGE_SORT_BY).optional().describe('Sort field. "date" (default) or "type".'),
|
|
1831
|
+
sortOrder: z47.enum(SORT_ORDER).optional().describe('Sort direction. "DESC" (default) or "ASC".'),
|
|
1832
|
+
includeCorrelations: z47.boolean().optional().describe(
|
|
1518
1833
|
"When true, include the ranking/conversion `correlation` object per change (CVR and search-term movement before vs after). Defaults to false."
|
|
1519
1834
|
),
|
|
1520
|
-
currentPage:
|
|
1521
|
-
pageSize:
|
|
1835
|
+
currentPage: z47.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
1836
|
+
pageSize: z47.number().int().min(1).max(50).optional().describe("Items per page (max 50). Defaults to 20.")
|
|
1522
1837
|
};
|
|
1523
1838
|
var getSellerListingChangesTool = {
|
|
1524
1839
|
name: "get_seller_listing_changes",
|
|
1525
1840
|
title: "List Listing Changes for a Seller",
|
|
1526
1841
|
description: "Use this when the user asks what changed on their Amazon listings \u2014 price, content (title/bullets/description), or image edits \u2014 for a seller account. Requires a `sellerId` + `marketplace` (use `list_seller_profiles` to discover them). Filter by `types`, `asin`/parent ASIN, `brand`, `search`, and a `startDate`/`endDate` range; sort with `sortBy`/`sortOrder`. Set `includeCorrelations: true` to attach the ranking/conversion impact per change. Returns a paginated list where each item has asin, title, imageUrl, date, type, contentType, description, previousValue, newValue, and (optionally) correlation, plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev).",
|
|
1527
|
-
inputSchema:
|
|
1842
|
+
inputSchema: inputSchema48,
|
|
1528
1843
|
annotations: { readOnlyHint: true },
|
|
1529
1844
|
handler: async (args, ctx) => {
|
|
1530
1845
|
return await httpGet(
|
|
@@ -1549,40 +1864,40 @@ var getSellerListingChangesTool = {
|
|
|
1549
1864
|
};
|
|
1550
1865
|
|
|
1551
1866
|
// src/tools/list-ppc-campaigns.ts
|
|
1552
|
-
import { z as
|
|
1867
|
+
import { z as z48 } from "zod";
|
|
1553
1868
|
var PPC_CAMPAIGNS_MAX_WINDOW_DAYS = 90;
|
|
1554
1869
|
var PPC_CAMPAIGNS_MAX_PAGE_SIZE = 50;
|
|
1555
|
-
var
|
|
1870
|
+
var inputSchema49 = {
|
|
1556
1871
|
...sellerScopedInputSchema,
|
|
1557
|
-
startDate:
|
|
1872
|
+
startDate: z48.string().regex(
|
|
1558
1873
|
ISO_8601,
|
|
1559
1874
|
"startDate must be an ISO-8601 date or timestamp (e.g. 2026-05-01 or 2026-05-01T00:00:00Z)"
|
|
1560
1875
|
).optional().describe("Start of the reporting window, ISO-8601. Defaults to 30 days before endDate."),
|
|
1561
|
-
endDate:
|
|
1876
|
+
endDate: z48.string().regex(
|
|
1562
1877
|
ISO_8601,
|
|
1563
1878
|
"endDate must be an ISO-8601 date or timestamp (e.g. 2026-05-31 or 2026-05-31T23:59:59Z)"
|
|
1564
1879
|
).optional().describe(
|
|
1565
1880
|
`End of the reporting window, ISO-8601. Defaults to now. At most ${PPC_CAMPAIGNS_MAX_WINDOW_DAYS} days after startDate.`
|
|
1566
1881
|
),
|
|
1567
|
-
asin:
|
|
1568
|
-
parentAsin:
|
|
1569
|
-
search:
|
|
1570
|
-
includePlacements:
|
|
1882
|
+
asin: z48.string().min(1).optional().describe("Only campaigns advertising this ASIN. Cannot be combined with parentAsin."),
|
|
1883
|
+
parentAsin: z48.string().min(1).optional().describe("Only campaigns advertising any ASIN of this variation family. Cannot be combined with asin."),
|
|
1884
|
+
search: z48.string().min(3).max(200).optional().describe("Partial match on campaign name or advertised ASIN. At least 3 characters."),
|
|
1885
|
+
includePlacements: z48.boolean().optional().describe(
|
|
1571
1886
|
"Include the per-placement breakdown (topOfSearch, restOfSearch, productPage, offAmazon, each with its bid adjustment). Defaults to true; set false for a smaller response when placements are not needed."
|
|
1572
1887
|
),
|
|
1573
|
-
sortBy:
|
|
1888
|
+
sortBy: z48.enum([...PPC_CAMPAIGN_BASE_SORT_BY, ...PPC_CAMPAIGN_PLACEMENT_SORT_BY]).optional().describe(
|
|
1574
1889
|
`Sort field. Defaults to "name". Any of ${PPC_CAMPAIGN_BASE_SORT_BY.join(", ")}. The placement fields (e.g. "tosSpend", "tosAcos", "ppBidAdjustment") are only accepted when includePlacements is not false.`
|
|
1575
1890
|
),
|
|
1576
|
-
sortOrder:
|
|
1577
|
-
state:
|
|
1578
|
-
currentPage:
|
|
1579
|
-
pageSize:
|
|
1891
|
+
sortOrder: z48.enum(SORT_ORDER).optional().describe('Sort direction. "ASC" (default) or "DESC".'),
|
|
1892
|
+
state: z48.enum(PPC_CAMPAIGN_STATES).optional().describe("Only ENABLED or only PAUSED campaigns. Omit for both."),
|
|
1893
|
+
currentPage: z48.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
1894
|
+
pageSize: z48.number().int().min(1).max(PPC_CAMPAIGNS_MAX_PAGE_SIZE).optional().describe(`Campaigns per page (max ${PPC_CAMPAIGNS_MAX_PAGE_SIZE}). Defaults to 20.`)
|
|
1580
1895
|
};
|
|
1581
1896
|
var listPpcCampaignsTool = {
|
|
1582
1897
|
name: "list_ppc_campaigns",
|
|
1583
1898
|
title: "List PPC Campaigns for a Seller",
|
|
1584
1899
|
description: `Use this when the user asks about their Sponsored Products campaigns \u2014 which campaigns spend the most, which have a high ACOS, how placements (top of search, rest of search, product pages) perform, or which campaigns advertise a given product. Requires a \`sellerId\` + \`marketplace\` (use \`list_seller_profiles\` to discover them). Narrow to one product with \`asin\`, or to a variation family with \`parentAsin\` (not both). The reporting window defaults to the last 30 days and cannot exceed ${PPC_CAMPAIGNS_MAX_WINDOW_DAYS} days. Returns a paginated list where each campaign has campaignId, name, type, state, targetingType, bidStrategy, budget { type, amount, currencyCode }, window totals (impressions, clicks, ctr, cpc, cvr, spend, unitsSold, orders, sales, tosImpressionShare, acos, roas, tacos), asinCount and, unless includePlacements is false, \`placements\`; plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev). To find the biggest spenders, sort with \`sortBy: "spend", sortOrder: "DESC"\` rather than paging through every campaign. Each call counts toward API usage and is rate limited (about 60 requests/minute). For per-keyword ad data of a Rank Radar, use \`get_rank_radar_ppc_data\`.`,
|
|
1585
|
-
inputSchema:
|
|
1900
|
+
inputSchema: inputSchema49,
|
|
1586
1901
|
annotations: { readOnlyHint: true },
|
|
1587
1902
|
handler: async (args, ctx) => {
|
|
1588
1903
|
if (args.asin && args.parentAsin) {
|
|
@@ -1613,13 +1928,13 @@ var listPpcCampaignsTool = {
|
|
|
1613
1928
|
};
|
|
1614
1929
|
|
|
1615
1930
|
// src/tools/get-asin-inventory-distribution.ts
|
|
1616
|
-
import { z as
|
|
1617
|
-
var
|
|
1618
|
-
sellerId:
|
|
1931
|
+
import { z as z49 } from "zod";
|
|
1932
|
+
var inputSchema50 = {
|
|
1933
|
+
sellerId: z49.string().min(1).describe(
|
|
1619
1934
|
"Amazon seller account ID as connected to DataDive. Get it from `list_seller_profiles`, or find it on the Connections page at https://2.datadive.tools."
|
|
1620
1935
|
),
|
|
1621
|
-
marketplace:
|
|
1622
|
-
asin:
|
|
1936
|
+
marketplace: z49.enum(SUPPORTED_MARKETPLACES).describe('Amazon marketplace code, e.g. "com" for amazon.com or "co.uk" for amazon.co.uk.'),
|
|
1937
|
+
asin: z49.string().regex(/^[A-Z0-9]{10}$/, "ASIN must be 10 uppercase alphanumeric characters (e.g. B08XYZ1234).").describe(
|
|
1623
1938
|
"Amazon Standard Identification Number (10 uppercase alphanumeric characters, e.g. B08XYZ1234)."
|
|
1624
1939
|
)
|
|
1625
1940
|
};
|
|
@@ -1627,7 +1942,7 @@ var getAsinInventoryDistributionTool = {
|
|
|
1627
1942
|
name: "get_asin_inventory_distribution",
|
|
1628
1943
|
title: "Get Inventory Metrics and Fulfillment-Center Distribution for an ASIN",
|
|
1629
1944
|
description: "Use this when the user asks about an ASIN's inventory: stock levels, days of stock or when it will run out, low-inventory or aged-inventory risk, low-inventory-level (LILF) or long-term storage (LTSF) fees, or where their units sit across Amazon's fulfillment network. Requires the Amazon sellerId (from `list_seller_profiles` or the user's DataDive Connections page at https://2.datadive.tools), the marketplace code, and the ASIN. Returns the metrics the DataDive Inventory page shows \u2014 fulfillableStock, totalStock, reservedStock, inboundStock, researchingStock, unfulfillableStock, daysOfStock (with daysOfStockSource AMAZON or ESTIMATE), daysOfStock30, daysOfStock90, inLowInventoryState, estWeeklyLilf, estLtsfNextAssessment, ltsfLastMonthActual, agedUnits, oldestUnitAgeDays, with fees in `currency` \u2014 plus totalSellableUnits and a per-FC `distribution` array (fc, state, availableStock, availableStockPercentage). A metric is null, never 0, when Amazon has no data (e.g. merchant-fulfilled); metrics the user's plan does not include are null and listed in `lockedFields` (say they need a plan upgrade, do not report them as zero). `lastUpdatedAt` dates the stock and metrics; `distributionLastUpdatedAt` dates the distribution, which is usually up to 2 days behind. Either may be null when no successful refresh happened in the last 30 days.",
|
|
1630
|
-
inputSchema:
|
|
1945
|
+
inputSchema: inputSchema50,
|
|
1631
1946
|
annotations: { readOnlyHint: true },
|
|
1632
1947
|
handler: async (args, ctx) => {
|
|
1633
1948
|
return await httpGet(
|
|
@@ -1640,18 +1955,18 @@ var getAsinInventoryDistributionTool = {
|
|
|
1640
1955
|
};
|
|
1641
1956
|
|
|
1642
1957
|
// src/tools/alert-query.ts
|
|
1643
|
-
import { z as
|
|
1958
|
+
import { z as z50 } from "zod";
|
|
1644
1959
|
var alertsQueryInputSchema = {
|
|
1645
|
-
sellerId:
|
|
1646
|
-
marketplace:
|
|
1647
|
-
status:
|
|
1960
|
+
sellerId: z50.string().min(1).max(50).optional().describe('Filter to a single connected Amazon seller account ID, e.g. "A1B2C3D4E5".'),
|
|
1961
|
+
marketplace: z50.enum(SUPPORTED_MARKETPLACES).optional().describe('Filter to a single Amazon marketplace code, e.g. "com" for amazon.com or "co.uk" for amazon.co.uk.'),
|
|
1962
|
+
status: z50.enum(ALERT_STATUSES).optional().describe(
|
|
1648
1963
|
"Lifecycle filter. `active` (default) returns unresolved alerts, `resolved` returns resolved alerts, `all` returns both. Dismissed alerts are never returned."
|
|
1649
1964
|
),
|
|
1650
|
-
updatedSince:
|
|
1965
|
+
updatedSince: z50.string().regex(ISO_8601, "updatedSince must be an ISO-8601 date or timestamp (e.g. 2026-05-01 or 2026-05-01T00:00:00Z)").optional().describe(
|
|
1651
1966
|
"ISO-8601 timestamp; return only alerts surfaced at or after this time (filters on `lastAlertedAt`). Use it to incrementally sync since your last poll. Defaults to the last 30 days when omitted."
|
|
1652
1967
|
),
|
|
1653
|
-
currentPage:
|
|
1654
|
-
pageSize:
|
|
1968
|
+
currentPage: z50.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
1969
|
+
pageSize: z50.number().int().min(1).max(50).optional().describe("Items per page (max 50). Defaults to 20.")
|
|
1655
1970
|
};
|
|
1656
1971
|
|
|
1657
1972
|
// src/tools/list-indexing-issue-alerts.ts
|
|
@@ -1701,12 +2016,12 @@ var listBlindSpendAlertsTool = {
|
|
|
1701
2016
|
};
|
|
1702
2017
|
|
|
1703
2018
|
// src/tools/get-quota.ts
|
|
1704
|
-
var
|
|
2019
|
+
var inputSchema51 = {};
|
|
1705
2020
|
var getQuotaTool = {
|
|
1706
2021
|
name: "get_quota",
|
|
1707
2022
|
title: "Get Quota Usage",
|
|
1708
2023
|
description: "Use this when the user asks how much quota or how many tokens they have left, or before creating a Niche Dive or Rank Radar to check remaining headroom. Returns current quota usage and capacity for each billable feature \u2014 DIVED_ASINS (Dive tokens), RANK_RADAR_KEYWORDS (tracked keywords), PRODUCT_BRIEF_ASINS, and AI_COPYWRITER_PROMPTS \u2014 each with `used` and `capacity` (null when unlimited / not applicable), plus `nextRefreshDate` (ISO-8601 timestamp of the next quota reset, or null). Takes no arguments.",
|
|
1709
|
-
inputSchema:
|
|
2024
|
+
inputSchema: inputSchema51,
|
|
1710
2025
|
annotations: { readOnlyHint: true },
|
|
1711
2026
|
handler: async (_args, ctx) => {
|
|
1712
2027
|
return await httpGet({ config: ctx.config, toolName: "get_quota" }, "/v1/quota");
|
|
@@ -1714,20 +2029,20 @@ var getQuotaTool = {
|
|
|
1714
2029
|
};
|
|
1715
2030
|
|
|
1716
2031
|
// src/tools/list-usage.ts
|
|
1717
|
-
import { z as
|
|
1718
|
-
var
|
|
1719
|
-
type:
|
|
1720
|
-
search:
|
|
1721
|
-
startDate:
|
|
1722
|
-
endDate:
|
|
1723
|
-
currentPage:
|
|
1724
|
-
pageSize:
|
|
2032
|
+
import { z as z51 } from "zod";
|
|
2033
|
+
var inputSchema52 = {
|
|
2034
|
+
type: z51.enum(BILLABLE_FEATURE_TYPES).optional().describe("Filter to a single billable feature type. Omit to return all types."),
|
|
2035
|
+
search: z51.string().min(1).optional().describe("Case-insensitive partial match on the user's name or email."),
|
|
2036
|
+
startDate: z51.string().regex(ISO_8601, "startDate must be an ISO-8601 date or timestamp (e.g. 2026-05-01 or 2026-05-01T00:00:00Z)").optional().describe("ISO-8601 date/timestamp; return only usage logs recorded on or after this time."),
|
|
2037
|
+
endDate: z51.string().regex(ISO_8601, "endDate must be an ISO-8601 date or timestamp (e.g. 2026-05-31 or 2026-05-31T23:59:59Z)").optional().describe("ISO-8601 date/timestamp; return only usage logs recorded on or before this time."),
|
|
2038
|
+
currentPage: z51.number().int().min(1).optional().describe("Page number, 1-indexed. Defaults to 1."),
|
|
2039
|
+
pageSize: z51.number().int().min(1).max(200).optional().describe("Items per page (max 200). Defaults to 50.")
|
|
1725
2040
|
};
|
|
1726
2041
|
var listUsageTool = {
|
|
1727
2042
|
name: "list_usage",
|
|
1728
2043
|
title: "List Billable Usage Logs",
|
|
1729
2044
|
description: "Use this when the user asks who consumed tokens, how their quota was spent, or wants an audit of billable activity over a date range. Retrieves a paginated list of billable feature usage logs for the organization \u2014 each entry is a token-consumption event (a dive, rank-radar creation, AI copywriter prompt, etc.). Filter by `type` (billable feature), `search` (user name/email), and `startDate`/`endDate`. Each item includes name, email, qty (tokens consumed), type, action (specific operation), nicheId/nicheName, rankRadarId, and date, plus pagination metadata (currentPage, pageSize, total, lastPage, hasNext, hasPrev).",
|
|
1730
|
-
inputSchema:
|
|
2045
|
+
inputSchema: inputSchema52,
|
|
1731
2046
|
annotations: { readOnlyHint: true },
|
|
1732
2047
|
handler: async (args, ctx) => {
|
|
1733
2048
|
return await httpGet(
|
|
@@ -1748,6 +2063,11 @@ var listUsageTool = {
|
|
|
1748
2063
|
// src/tools/index.ts
|
|
1749
2064
|
var allTools = [
|
|
1750
2065
|
listNichesTool,
|
|
2066
|
+
listFastKeywordsTool,
|
|
2067
|
+
getFastKeywordsTool,
|
|
2068
|
+
getFastKeywordsKeywordsTool,
|
|
2069
|
+
listSpacesTool,
|
|
2070
|
+
listLabelsTool,
|
|
1751
2071
|
getNicheKeywordsTool,
|
|
1752
2072
|
listKeywordExclusionsTool,
|
|
1753
2073
|
getNicheRootsTool,
|
|
@@ -1759,6 +2079,8 @@ var allTools = [
|
|
|
1759
2079
|
getRankRadarPpcDataTool,
|
|
1760
2080
|
listRankRadarTagsTool,
|
|
1761
2081
|
createRankRadarTool,
|
|
2082
|
+
runFastKeywordsTool,
|
|
2083
|
+
refreshFastKeywordsTool,
|
|
1762
2084
|
createNicheDiveTool,
|
|
1763
2085
|
createNicheDiveFromCompetitorsListTool,
|
|
1764
2086
|
rediveNicheTool,
|
|
@@ -1767,6 +2089,10 @@ var allTools = [
|
|
|
1767
2089
|
removeNicheKeywordsTool,
|
|
1768
2090
|
addKeywordExclusionsTool,
|
|
1769
2091
|
removeKeywordExclusionsTool,
|
|
2092
|
+
addNicheSpacesTool,
|
|
2093
|
+
removeNicheSpacesTool,
|
|
2094
|
+
addNicheLabelsTool,
|
|
2095
|
+
removeNicheLabelsTool,
|
|
1770
2096
|
addRankRadarSearchTermsTool,
|
|
1771
2097
|
pauseRankRadarSearchTermsTool,
|
|
1772
2098
|
resumeRankRadarSearchTermsTool,
|
|
@@ -1794,6 +2120,20 @@ var allTools = [
|
|
|
1794
2120
|
|
|
1795
2121
|
// src/whats-new.ts
|
|
1796
2122
|
var WHATS_NEW = [
|
|
2123
|
+
{
|
|
2124
|
+
version: "0.20.1",
|
|
2125
|
+
released: "2026-10-23",
|
|
2126
|
+
items: [
|
|
2127
|
+
"Run Fast Keywords from just an ASIN and read the result (`run_fast_keywords`, `get_fast_keywords`, `get_fast_keywords_keywords`, `list_fast_keywords`, `refresh_fast_keywords`). A run costs 1 Dive token and asks you to confirm first. A finished run can be refreshed once every 24 hours, and `create_niche_dive` can now link a full niche dive to the Fast Keywords run it follows."
|
|
2128
|
+
]
|
|
2129
|
+
},
|
|
2130
|
+
{
|
|
2131
|
+
version: "0.20.0",
|
|
2132
|
+
released: "2026-10-23",
|
|
2133
|
+
items: [
|
|
2134
|
+
"See your Spaces and labels (`list_spaces`, `list_labels`), put a niche into them or take it out (`add_niche_spaces`, `remove_niche_spaces`, `add_niche_labels`, `remove_niche_labels`), and filter `list_niches` and `list_rank_radars` by Space and label. Free. Changing a niche's Spaces and labels is for the organization owner or a team admin; a Space you only have view rights on is refused."
|
|
2135
|
+
]
|
|
2136
|
+
},
|
|
1797
2137
|
{
|
|
1798
2138
|
version: "0.17.1",
|
|
1799
2139
|
released: "2026-10-13",
|