@lightsage/mcp 0.4.17 → 0.4.18

package/src/models/v2promptrunscancelop.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d19d5cd47b00
+ */
+
+import * as z from "zod";
+import {
+  HTTPValidationError,
+  HTTPValidationError$zodSchema,
+} from "./httpvalidationerror.js";
+import {
+  V2PromptRunJobResponse,
+  V2PromptRunJobResponse$zodSchema,
+} from "./v2promptrunjobresponse.js";
+
+export type V2PromptRunsCancelRequest = { run_id: string };
+
+export const V2PromptRunsCancelRequest$zodSchema: z.ZodType<
+  V2PromptRunsCancelRequest
+> = z.object({
+  run_id: z.string().describe(
+    "Run ID returned by `POST /v2/prompts/runs`, not a stored prompt result ID.",
+  ),
+});
+
+/**
+ * Prompt run cancellation is temporarily unavailable.
+ */
+export type V2PromptRunsCancelServiceUnavailableResponseBody = {
+  detail: string;
+};
+
+export const V2PromptRunsCancelServiceUnavailableResponseBody$zodSchema:
+  z.ZodType<V2PromptRunsCancelServiceUnavailableResponseBody> = z.object({
+    detail: z.string(),
+  }).describe("Prompt run cancellation is temporarily unavailable.");
+
+/**
+ * The prompt run has already completed or failed.
+ */
+export type V2PromptRunsCancelConflictResponseBody = { detail: string };
+
+export const V2PromptRunsCancelConflictResponseBody$zodSchema: z.ZodType<
+  V2PromptRunsCancelConflictResponseBody
+> = z.object({
+  detail: z.string(),
+}).describe("The prompt run has already completed or failed.");
+
+/**
+ * Prompt run not found. Use the run ID returned when you started the prompt run.
+ */
+export type V2PromptRunsCancelNotFoundResponseBody = { detail: string };
+
+export const V2PromptRunsCancelNotFoundResponseBody$zodSchema: z.ZodType<
+  V2PromptRunsCancelNotFoundResponseBody
+> = z.object({
+  detail: z.string(),
+}).describe(
+  "Prompt run not found. Use the run ID returned when you started the prompt run.",
+);
+
+/**
+ * The prompt run ID is not a valid UUID.
+ */
+export type V2PromptRunsCancelBadRequestResponseBody = { detail: string };
+
+export const V2PromptRunsCancelBadRequestResponseBody$zodSchema: z.ZodType<
+  V2PromptRunsCancelBadRequestResponseBody
+> = z.object({
+  detail: z.string(),
+}).describe("The prompt run ID is not a valid UUID.");
+
+export type V2PromptRunsCancelResponse =
+  | V2PromptRunJobResponse
+  | V2PromptRunsCancelBadRequestResponseBody
+  | V2PromptRunsCancelNotFoundResponseBody
+  | V2PromptRunsCancelConflictResponseBody
+  | V2PromptRunsCancelServiceUnavailableResponseBody
+  | HTTPValidationError;
+
+export const V2PromptRunsCancelResponse$zodSchema: z.ZodType<
+  V2PromptRunsCancelResponse
+> = z.union([
+  V2PromptRunJobResponse$zodSchema,
+  z.lazy(() => V2PromptRunsCancelBadRequestResponseBody$zodSchema),
+  z.lazy(() => V2PromptRunsCancelNotFoundResponseBody$zodSchema),
+  z.lazy(() => V2PromptRunsCancelConflictResponseBody$zodSchema),
+  z.lazy(() => V2PromptRunsCancelServiceUnavailableResponseBody$zodSchema),
+  HTTPValidationError$zodSchema,
+]);

package/src/models/v2visibilitycitationslistop.ts

@@ -35,6 +35,7 @@ export type V2VisibilityCitationsListRequest = {
   platform?: string | undefined;
   source_type?: V2VisibilityCitationsListSourceType | undefined;
   limit?: number | undefined;
+  period?: string | undefined;
 };
 
 export const V2VisibilityCitationsListRequest$zodSchema: z.ZodType<
@@ -44,6 +45,9 @@ export const V2VisibilityCitationsListRequest$zodSchema: z.ZodType<
     "Inclusive range end; defaults to today.",
   ).optional(),
   limit: z.int().default(20),
+  period: z.string().describe(
+    "Named period, resolved in UTC by the server: `last_7_days`, `last_14_days`, `last_30_days`, `last_90_days` (N days ending today), `this_week`, `last_week`, an ISO week such as `2026-W43` (Monday to Sunday), `this_month`, `last_month`, a month such as `2026-10`, `this_quarter`, `last_quarter`, or a quarter such as `2026Q4`. A current week, month, or quarter ends today. The response's `period` gives the resolved dates and the matching previous period. Do not combine with `start_date` or `end_date`.",
+  ).optional(),
   platform: z.string().describe("Optional answer-platform ID, name, or slug.")
     .optional(),
   source_type: V2VisibilityCitationsListSourceType$zodSchema.default("all"),

package/src/models/v2visibilitycitationssummaryretrieveop.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 704776418479
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$zodSchema,
+} from "./httpvalidationerror.js";
+import {
+  PublicCitationSummaryResponse,
+  PublicCitationSummaryResponse$zodSchema,
+} from "./publiccitationsummaryresponse.js";
+
+/**
+ * How to group citations.
+ */
+export const V2VisibilityCitationsSummaryRetrieveGroupBy = {
+  UrlPrefix: "url_prefix",
+  Url: "url",
+  Domain: "domain",
+  Day: "day",
+} as const;
+/**
+ * How to group citations.
+ */
+export type V2VisibilityCitationsSummaryRetrieveGroupBy = ClosedEnum<
+  typeof V2VisibilityCitationsSummaryRetrieveGroupBy
+>;
+
+export const V2VisibilityCitationsSummaryRetrieveGroupBy$zodSchema = z.enum([
+  "url_prefix",
+  "url",
+  "domain",
+  "day",
+]).describe("How to group citations.");
+
+/**
+ * All citations, only owned company domains, or only external ones.
+ */
+export const V2VisibilityCitationsSummaryRetrieveSourceType = {
+  All: "all",
+  Owned: "owned",
+  External: "external",
+} as const;
+/**
+ * All citations, only owned company domains, or only external ones.
+ */
+export type V2VisibilityCitationsSummaryRetrieveSourceType = ClosedEnum<
+  typeof V2VisibilityCitationsSummaryRetrieveSourceType
+>;
+
+export const V2VisibilityCitationsSummaryRetrieveSourceType$zodSchema = z.enum([
+  "all",
+  "owned",
+  "external",
+]).describe(
+  "All citations, only owned company domains, or only external ones.",
+);
+
+export type V2VisibilityCitationsSummaryRetrieveRequest = {
+  period?: string | undefined;
+  start_date?: string | undefined;
+  end_date?: string | undefined;
+  group_by?: V2VisibilityCitationsSummaryRetrieveGroupBy | undefined;
+  url_prefix?: string | undefined;
+  source_type?: V2VisibilityCitationsSummaryRetrieveSourceType | undefined;
+  platform?: string | undefined;
+  limit?: number | undefined;
+};
+
+export const V2VisibilityCitationsSummaryRetrieveRequest$zodSchema: z.ZodType<
+  V2VisibilityCitationsSummaryRetrieveRequest
+> = z.object({
+  end_date: z.string().date().describe(
+    "Inclusive range end; defaults to today.",
+  ).optional(),
+  group_by: V2VisibilityCitationsSummaryRetrieveGroupBy$zodSchema.default(
+    "url_prefix",
+  ).describe("How to group citations."),
+  limit: z.int().default(20).describe(
+    "Groups to return; `day` groups return every day.",
+  ),
+  period: z.string().describe(
+    "Named period, resolved in UTC by the server: `last_7_days`, `last_14_days`, `last_30_days`, `last_90_days` (N days ending today), `this_week`, `last_week`, an ISO week such as `2026-W43` (Monday to Sunday), `this_month`, `last_month`, a month such as `2026-10`, `this_quarter`, `last_quarter`, or a quarter such as `2026Q4`. A current week, month, or quarter ends today. The response's `period` gives the resolved dates and the matching previous period. Do not combine with `start_date` or `end_date`.",
+  ).optional(),
+  platform: z.string().describe("Optional answer-platform ID, name, or slug.")
+    .optional(),
+  source_type: V2VisibilityCitationsSummaryRetrieveSourceType$zodSchema.default(
+    "all",
+  ).describe(
+    "All citations, only owned company domains, or only external ones.",
+  ),
+  start_date: z.string().date().describe(
+    "Inclusive range start; defaults to 30 days before the end date. The range may span at most 90 days.",
+  ).optional(),
+  url_prefix: z.string().describe(
+    "Only citations under this URL prefix, such as `https://example.com/blog/`. Scheme and `www.` are ignored.",
+  ).optional(),
+});
+
+export type V2VisibilityCitationsSummaryRetrieveResponse =
+  | PublicCitationSummaryResponse
+  | HTTPValidationError;
+
+export const V2VisibilityCitationsSummaryRetrieveResponse$zodSchema: z.ZodType<
+  V2VisibilityCitationsSummaryRetrieveResponse
+> = z.union([
+  PublicCitationSummaryResponse$zodSchema,
+  HTTPValidationError$zodSchema,
+]);

package/src/models/v2visibilitycurrentretrieveop.ts

@@ -16,6 +16,7 @@ import {
 export type V2VisibilityCurrentRetrieveRequest = {
   start_date?: string | undefined;
   end_date?: string | undefined;
+  period?: string | undefined;
 };
 
 export const V2VisibilityCurrentRetrieveRequest$zodSchema: z.ZodType<
@@ -24,6 +25,9 @@ export const V2VisibilityCurrentRetrieveRequest$zodSchema: z.ZodType<
   end_date: z.string().date().describe(
     "Inclusive range end; defaults to today.",
   ).optional(),
+  period: z.string().describe(
+    "Named period, resolved in UTC by the server: `last_7_days`, `last_14_days`, `last_30_days`, `last_90_days` (N days ending today), `this_week`, `last_week`, an ISO week such as `2026-W43` (Monday to Sunday), `this_month`, `last_month`, a month such as `2026-10`, `this_quarter`, `last_quarter`, or a quarter such as `2026Q4`. A current week, month, or quarter ends today. The response's `period` gives the resolved dates and the matching previous period. Do not combine with `start_date` or `end_date`.",
+  ).optional(),
   start_date: z.string().date().describe(
     "Inclusive range start; defaults to 30 days before the end date. The range may span at most 90 days.",
   ).optional(),

package/src/models/v2visibilityoverviewretrieveop.ts

@@ -16,6 +16,7 @@ import {
 export type V2VisibilityOverviewRetrieveRequest = {
   start_date?: string | undefined;
   end_date?: string | undefined;
+  period?: string | undefined;
 };
 
 export const V2VisibilityOverviewRetrieveRequest$zodSchema: z.ZodType<
@@ -24,6 +25,9 @@ export const V2VisibilityOverviewRetrieveRequest$zodSchema: z.ZodType<
   end_date: z.string().date().describe(
     "Inclusive range end; defaults to today.",
   ).optional(),
+  period: z.string().describe(
+    "Named period, resolved in UTC by the server: `last_7_days`, `last_14_days`, `last_30_days`, `last_90_days` (N days ending today), `this_week`, `last_week`, an ISO week such as `2026-W43` (Monday to Sunday), `this_month`, `last_month`, a month such as `2026-10`, `this_quarter`, `last_quarter`, or a quarter such as `2026Q4`. A current week, month, or quarter ends today. The response's `period` gives the resolved dates and the matching previous period. Do not combine with `start_date` or `end_date`.",
+  ).optional(),
   start_date: z.string().date().describe(
     "Inclusive range start; defaults to 30 days before the end date. The range may span at most 90 days.",
   ).optional(),

package/src/models/v2visibilitypromptsretrieveop.ts

@@ -16,6 +16,7 @@ import {
 export type V2VisibilityPromptsRetrieveRequest = {
   start_date?: string | undefined;
   end_date?: string | undefined;
+  period?: string | undefined;
 };
 
 export const V2VisibilityPromptsRetrieveRequest$zodSchema: z.ZodType<
@@ -24,6 +25,9 @@ export const V2VisibilityPromptsRetrieveRequest$zodSchema: z.ZodType<
   end_date: z.string().date().describe(
     "Inclusive range end; defaults to today.",
   ).optional(),
+  period: z.string().describe(
+    "Named period, resolved in UTC by the server: `last_7_days`, `last_14_days`, `last_30_days`, `last_90_days` (N days ending today), `this_week`, `last_week`, an ISO week such as `2026-W43` (Monday to Sunday), `this_month`, `last_month`, a month such as `2026-10`, `this_quarter`, `last_quarter`, or a quarter such as `2026Q4`. A current week, month, or quarter ends today. The response's `period` gives the resolved dates and the matching previous period. Do not combine with `start_date` or `end_date`.",
+  ).optional(),
   start_date: z.string().date().describe(
     "Inclusive range start; defaults to 30 days before the end date. The range may span at most 90 days.",
   ).optional(),

package/src/tool-names.ts

@@ -10,20 +10,24 @@ export const toolNames: Array<{ name: string; description: string }>= [
   },
   {
     "name": "visibility-current-retrieve",
-    "description": "Retrieve Current Visibility\n\nReturns recommendation score, visibility score, ranks, and date-range metadata for the configured primary company. Metrics are computed from active prompts only; when no data exists, values are `null`."
+    "description": "Retrieve Current Visibility\n\nReturns recommendation score, visibility score, ranks, and date-range metadata for the configured primary company, with the same metrics for the previous period, run coverage, and per-run rates. Metrics are computed from active prompts only; when no data exists, values are `null`. Pass `period` (for example `last_30_days` or `2026Q4`) instead of computing dates."
   },
   {
     "name": "visibility-overview-retrieve",
-    "description": "Retrieve Visibility Overview\n\nReturns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison. Calculated from active prompts only."
+    "description": "Retrieve Visibility Overview\n\nReturns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison, with run coverage and per-run rates against the previous period. Calculated from active prompts only."
   },
   {
     "name": "visibility-citations-list",
-    "description": "List Top Cited Urls\n\nReturns URL-level citation counts ranked from most to least cited. Results can be filtered by platform and to owned or external sources."
+    "description": "List Top Cited Urls\n\nReturns URL-level citation counts ranked from most to least cited. Results can be filtered by platform and to owned or external sources. For totals by URL prefix, domain, or day compared with the previous period, use the citations summary."
   },
   {
     "name": "visibility-prompts-retrieve",
     "description": "Retrieve Prompt Visibility Report\n\nReturns per-topic and per-prompt visibility metrics including recommendation score, rank, visibility score, average position, and citation counts."
   },
+  {
+    "name": "visibility-citations-summary-retrieve",
+    "description": "Retrieve Citation Summary\n\nReturns citation totals grouped by URL prefix (domain and first path segment, such as `example.com/blog`), URL, domain, or day, each compared with the previous period, with per-run rates and run coverage. Filter to one section of a site with `url_prefix`, for example `https://example.com/blog/`. Aggregated in one call; use it instead of paging the citations list."
+  },
   {
     "name": "prompts-list",
     "description": "List Prompts\n\nReturns active and inactive prompts by default. Set `include_archived` to include archived prompts."
@@ -70,12 +74,16 @@ export const toolNames: Array<{ name: string; description: string }>= [
   },
   {
     "name": "prompts-run",
-    "description": "Run Prompts\n\nQueue saved prompts using the organization's configured targets.\n\nProvide `prompt_ids` to run selected prompts, or omit them to run all active\nprompts. Saved prompt run settings apply to coding-agent targets. The\nresponse returns a run ID to poll with\n`GET /v2/prompts/runs/{run_id}/status`."
+    "description": "Run Prompts\n\nQueue saved prompts on answer engines and coding agents.\n\nProvide `prompt_ids` to run selected prompts, or omit them to run all active\nprompts. By default the run uses the organization's configured targets.\nProvide `agent` with IDs from `GET /v2/agents` to run the prompts on\nspecific coding-agent harnesses and models instead, for example to compare\nhow several coding tools answer the same developer question. Results\ninclude mentions and citations. Saved prompt run settings apply to\ncoding-agent targets. The response returns a run ID to poll with\n`GET /v2/prompts/runs/{run_id}/status`."
   },
   {
     "name": "prompts-run-status",
     "description": "Get Prompt Run Status\n\nReturn status and progress for a queued prompt run.\n\nPoll this endpoint until `status` is `completed`, `failed`, or `cancelled`.\nIndividual stored results are available from `GET /v2/prompts/runs`."
   },
+  {
+    "name": "prompts-run-cancel",
+    "description": "Cancel a prompt run\n\nMarks an active prompt run as cancelled and prevents queued prompts from starting. Running coding-agent attempts are stopped asynchronously. Requests already sent to an answer platform cannot be recalled, so prompts already in progress may still finish and store their results, but the run stays cancelled. Prompts that never start use no usage-based credits. The response has the same shape as the status operation, with cancelled prompts counted in `progress.cancelled`. Repeating this request for an already-cancelled run is safe."
+  },
   {
     "name": "opportunities-list",
     "description": "List Opportunities\n\nReturns ranked opportunities computed from stored prompt visibility results. Each includes an `execution_prompt` with context for an AI agent. Default window is 30 days."
@@ -114,7 +122,7 @@ export const toolNames: Array<{ name: string; description: string }>= [
   },
   {
     "name": "agent-analytics-summary-retrieve",
-    "description": "Retrieve Agent Analytics Summary\n\nReturns a site's visits by traffic type (coding agents, user-requested AI fetches, AI search, AI training, other bots, and people) for the date range and for the same number of days before it."
+    "description": "Retrieve Agent Analytics Summary\n\nReturns a site's visits by traffic type (coding agents, user-requested AI fetches, AI search, AI training, other bots, and people) for the date range and for the previous period (the same number of days before it, or the previous calendar week, month, or quarter for a named `period`)."
   },
   {
     "name": "agent-analytics-sources-list",
@@ -138,7 +146,7 @@ export const toolNames: Array<{ name: string; description: string }>= [
   },
   {
     "name": "evals-create",
-    "description": "Create Eval\n\nCreates a reusable simulation definition with one or more task prompts and judges. Optional agents, persona, CLI installations, MCP servers, setup commands, cleanup commands, grounding policy, repeat count, and tags are saved with the eval. `search_grounding` supports `disabled`, `enabled`, and `default`; `default` preserves normal platform behavior. Creating the eval does not start a run and does not accept secret environment values."
+    "description": "Create Eval\n\nCreates a reusable simulation definition with one or more task prompts and judges. Optional agents, persona, CLI installations, MCP servers, setup commands, cleanup commands, grounding policy, repeat count, and tags are saved with the eval. `search_grounding` supports `disabled`, `enabled`, and `default`; `default` preserves normal platform behavior. Creating the eval does not start a run and does not accept secret environment values.\n\nEvals measure how well agents complete tasks with your product. To track how agents and answer engines answer research questions, including which brands they mention and cite, run prompts with `POST /v2/prompts/runs` instead."
   },
   {
     "name": "evals-batch-create",
@@ -178,7 +186,7 @@ export const toolNames: Array<{ name: string; description: string }>= [
   },
   {
     "name": "evals-run",
-    "description": "Start an eval run\n\nQueues a durable eval job and returns immediately with a polling ID. Poll `GET /v2/eval-runs/{run_id}` until its status reaches a terminal value; once finished it also returns the results and analysis. Follow a run live with the monitor operation.\n\nSend one of these flat request forms:\n\n- **Saved eval:** provide `eval_id`; optionally replace its prompts, persona, agents, CLIs, MCPs, setup commands, cleanup commands, or runs for this launch. A saved configuration can still provide repository, environment, skills, and legacy tool selections.\n- **Direct create-and-run:** provide `prompts`, `judges`, and `agent`. You may also provide a persona, tags, repository, write-only environment variables, saved or inline CLIs and MCP servers, skills, setup commands, and cleanup commands.\n\nThe run fans out across prompts × agents × runs. Persona is shared metadata and does not multiply attempts. No separate `mode` field is required. If the organization lacks the estimated credits, the request fails with `402` before dispatching work.\n\nA saved or inline environment containing an empty or placeholder credential is rejected with `400` before any evaluation is dispatched."
+    "description": "Start an eval run\n\nQueues a durable eval job and returns immediately with a polling ID. Poll `GET /v2/eval-runs/{run_id}` until its status reaches a terminal value; once finished it also returns the results and analysis. Follow a run live with the monitor operation.\n\nEval runs measure how well agents complete tasks with your product. To compare how coding agents and answer engines answer the same research question, with mentions and citations, use `POST /v2/prompts/runs` with `agent` instead.\n\nSend one of these flat request forms:\n\n- **Saved eval:** provide `eval_id`; optionally replace its prompts, persona, agents, CLIs, MCPs, setup commands, cleanup commands, or runs for this launch. A saved configuration can still provide repository, environment, skills, and legacy tool selections.\n- **Direct create-and-run:** provide `prompts`, `judges`, and `agent`. You may also provide a persona, tags, repository, write-only environment variables, saved or inline CLIs and MCP servers, skills, setup commands, and cleanup commands.\n\nThe run fans out across prompts × agents × runs. Persona is shared metadata and does not multiply attempts. No separate `mode` field is required. If the organization lacks the estimated credits, the request fails with `402` before dispatching work.\n\nA saved or inline environment containing an empty or placeholder credential is rejected with `400` before any evaluation is dispatched."
   },
   {
     "name": "evals-cancel",
@@ -250,7 +258,7 @@ export const toolNames: Array<{ name: string; description: string }>= [
   },
   {
     "name": "agents-list",
-    "description": "List Agents\n\nReturns the harness-and-model combinations your plan can run, as single agent IDs for use in eval runs."
+    "description": "List Agents\n\nReturns the coding-agent harness-and-model combinations your plan can run, as single agent IDs. Pass them as `agent` to `POST /v2/prompts/runs` to see how coding agents answer your prompts, with mentions and citations; to `POST /v2/agent-preference/evals` to see whether agents recommend your company over one competitor; or to `POST /v2/evals` and `POST /v2/eval-runs` to measure how well agents complete tasks with your product."
   },
   {
     "name": "repositories-list",