@lightsage/mcp 0.4.17 → 0.4.18
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 +2 -2
- package/bin/mcp-server.js +787 -201
- package/bin/mcp-server.js.map +72 -55
- package/esm/funcs/agentAnalyticsCountriesList.js +1 -0
- package/esm/funcs/agentAnalyticsCountriesList.js.map +1 -1
- package/esm/funcs/agentAnalyticsErrorPagesList.js +1 -0
- package/esm/funcs/agentAnalyticsErrorPagesList.js.map +1 -1
- package/esm/funcs/agentAnalyticsPagesList.js +1 -0
- package/esm/funcs/agentAnalyticsPagesList.js.map +1 -1
- package/esm/funcs/agentAnalyticsSourcesList.js +1 -0
- package/esm/funcs/agentAnalyticsSourcesList.js.map +1 -1
- package/esm/funcs/agentAnalyticsSummaryRetrieve.d.ts +1 -1
- package/esm/funcs/agentAnalyticsSummaryRetrieve.js +2 -1
- package/esm/funcs/agentAnalyticsSummaryRetrieve.js.map +1 -1
- package/esm/funcs/agentsList.d.ts +1 -1
- package/esm/funcs/agentsList.js +1 -1
- package/esm/funcs/evalsCreate.d.ts +2 -0
- package/esm/funcs/evalsCreate.d.ts.map +1 -1
- package/esm/funcs/evalsCreate.js +2 -0
- package/esm/funcs/evalsCreate.js.map +1 -1
- package/esm/funcs/evalsRun.d.ts +2 -0
- package/esm/funcs/evalsRun.d.ts.map +1 -1
- package/esm/funcs/evalsRun.js +2 -0
- package/esm/funcs/evalsRun.js.map +1 -1
- package/esm/funcs/promptsRun.d.ts +7 -3
- package/esm/funcs/promptsRun.d.ts.map +1 -1
- package/esm/funcs/promptsRun.js +7 -3
- package/esm/funcs/promptsRun.js.map +1 -1
- package/esm/funcs/promptsRunCancel.d.ts +16 -0
- package/esm/funcs/promptsRunCancel.d.ts.map +1 -0
- package/esm/funcs/promptsRunCancel.js +88 -0
- package/esm/funcs/promptsRunCancel.js.map +1 -0
- package/esm/funcs/visibilityCitationsList.d.ts +1 -1
- package/esm/funcs/visibilityCitationsList.js +2 -1
- package/esm/funcs/visibilityCitationsList.js.map +1 -1
- package/esm/funcs/visibilityCitationsSummaryRetrieve.d.ts +16 -0
- package/esm/funcs/visibilityCitationsSummaryRetrieve.d.ts.map +1 -0
- package/esm/funcs/visibilityCitationsSummaryRetrieve.js +93 -0
- package/esm/funcs/visibilityCitationsSummaryRetrieve.js.map +1 -0
- package/esm/funcs/visibilityCurrentRetrieve.d.ts +1 -1
- package/esm/funcs/visibilityCurrentRetrieve.js +2 -1
- package/esm/funcs/visibilityCurrentRetrieve.js.map +1 -1
- package/esm/funcs/visibilityOverviewRetrieve.d.ts +1 -1
- package/esm/funcs/visibilityOverviewRetrieve.js +2 -1
- package/esm/funcs/visibilityOverviewRetrieve.js.map +1 -1
- package/esm/funcs/visibilityPromptsRetrieve.js +1 -0
- package/esm/funcs/visibilityPromptsRetrieve.js.map +1 -1
- package/esm/landing-page.js +1 -1
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.js +2 -2
- package/esm/mcp-server/mcp-server.js +1 -1
- package/esm/mcp-server/server.d.ts.map +1 -1
- package/esm/mcp-server/server.js +4 -0
- package/esm/mcp-server/server.js.map +1 -1
- package/esm/mcp-server/tools/agentAnalyticsSummaryRetrieve.js +1 -1
- package/esm/mcp-server/tools/agentAnalyticsSummaryRetrieve.js.map +1 -1
- package/esm/mcp-server/tools/agentsList.js +1 -1
- package/esm/mcp-server/tools/agentsList.js.map +1 -1
- package/esm/mcp-server/tools/evalsCreate.d.ts.map +1 -1
- package/esm/mcp-server/tools/evalsCreate.js +3 -1
- package/esm/mcp-server/tools/evalsCreate.js.map +1 -1
- package/esm/mcp-server/tools/evalsRun.d.ts.map +1 -1
- package/esm/mcp-server/tools/evalsRun.js +2 -0
- package/esm/mcp-server/tools/evalsRun.js.map +1 -1
- package/esm/mcp-server/tools/promptsRun.d.ts.map +1 -1
- package/esm/mcp-server/tools/promptsRun.js +7 -3
- package/esm/mcp-server/tools/promptsRun.js.map +1 -1
- package/esm/mcp-server/tools/promptsRunCancel.d.ts +7 -0
- package/esm/mcp-server/tools/promptsRunCancel.d.ts.map +1 -0
- package/esm/mcp-server/tools/promptsRunCancel.js +35 -0
- package/esm/mcp-server/tools/promptsRunCancel.js.map +1 -0
- package/esm/mcp-server/tools/visibilityCitationsList.js +1 -1
- package/esm/mcp-server/tools/visibilityCitationsList.js.map +1 -1
- package/esm/mcp-server/tools/visibilityCitationsSummaryRetrieve.d.ts +7 -0
- package/esm/mcp-server/tools/visibilityCitationsSummaryRetrieve.d.ts.map +1 -0
- package/esm/mcp-server/tools/visibilityCitationsSummaryRetrieve.js +35 -0
- package/esm/mcp-server/tools/visibilityCitationsSummaryRetrieve.js.map +1 -0
- package/esm/mcp-server/tools/visibilityCurrentRetrieve.js +1 -1
- package/esm/mcp-server/tools/visibilityCurrentRetrieve.js.map +1 -1
- package/esm/mcp-server/tools/visibilityOverviewRetrieve.js +1 -1
- package/esm/mcp-server/tools/visibilityOverviewRetrieve.js.map +1 -1
- package/esm/models/createv2promptrequest.js +1 -1
- package/esm/models/createv2promptrequest.js.map +1 -1
- package/esm/models/createv2promptrunrequest.d.ts +1 -0
- package/esm/models/createv2promptrunrequest.d.ts.map +1 -1
- package/esm/models/createv2promptrunrequest.js +2 -1
- package/esm/models/createv2promptrunrequest.js.map +1 -1
- package/esm/models/publicagentanalyticscountrylistresponse.d.ts +2 -0
- package/esm/models/publicagentanalyticscountrylistresponse.d.ts.map +1 -1
- package/esm/models/publicagentanalyticscountrylistresponse.js +2 -0
- package/esm/models/publicagentanalyticscountrylistresponse.js.map +1 -1
- package/esm/models/publicagentanalyticserrorpagelistresponse.d.ts +2 -0
- package/esm/models/publicagentanalyticserrorpagelistresponse.d.ts.map +1 -1
- package/esm/models/publicagentanalyticserrorpagelistresponse.js +2 -0
- package/esm/models/publicagentanalyticserrorpagelistresponse.js.map +1 -1
- package/esm/models/publicagentanalyticspagelistresponse.d.ts +2 -0
- package/esm/models/publicagentanalyticspagelistresponse.d.ts.map +1 -1
- package/esm/models/publicagentanalyticspagelistresponse.js +2 -0
- package/esm/models/publicagentanalyticspagelistresponse.js.map +1 -1
- package/esm/models/publicagentanalyticssourcelistresponse.d.ts +2 -0
- package/esm/models/publicagentanalyticssourcelistresponse.d.ts.map +1 -1
- package/esm/models/publicagentanalyticssourcelistresponse.js +2 -0
- package/esm/models/publicagentanalyticssourcelistresponse.js.map +1 -1
- package/esm/models/publicagentanalyticssummary.d.ts +2 -0
- package/esm/models/publicagentanalyticssummary.d.ts.map +1 -1
- package/esm/models/publicagentanalyticssummary.js +2 -0
- package/esm/models/publicagentanalyticssummary.js.map +1 -1
- package/esm/models/publiccitationsummarygroup.d.ts +17 -0
- package/esm/models/publiccitationsummarygroup.d.ts.map +1 -0
- package/esm/models/publiccitationsummarygroup.js +20 -0
- package/esm/models/publiccitationsummarygroup.js.map +1 -0
- package/esm/models/publiccitationsummaryresponse.d.ts +61 -0
- package/esm/models/publiccitationsummaryresponse.d.ts.map +1 -0
- package/esm/models/publiccitationsummaryresponse.js +58 -0
- package/esm/models/publiccitationsummaryresponse.js.map +1 -0
- package/esm/models/publiccitationsummarytotals.d.ts +14 -0
- package/esm/models/publiccitationsummarytotals.d.ts.map +1 -0
- package/esm/models/publiccitationsummarytotals.js +17 -0
- package/esm/models/publiccitationsummarytotals.js.map +1 -0
- package/esm/models/publiccoverage.d.ts +12 -0
- package/esm/models/publiccoverage.d.ts.map +1 -0
- package/esm/models/publiccoverage.js +15 -0
- package/esm/models/publiccoverage.js.map +1 -0
- package/esm/models/publiccoverageday.d.ts +41 -0
- package/esm/models/publiccoverageday.d.ts.map +1 -0
- package/esm/models/publiccoverageday.js +39 -0
- package/esm/models/publiccoverageday.js.map +1 -0
- package/esm/models/publiccurrentvisibilityresponse.d.ts +8 -0
- package/esm/models/publiccurrentvisibilityresponse.d.ts.map +1 -1
- package/esm/models/publiccurrentvisibilityresponse.js +8 -0
- package/esm/models/publiccurrentvisibilityresponse.js.map +1 -1
- package/esm/models/publicperiodcoverage.d.ts +13 -0
- package/esm/models/publicperiodcoverage.d.ts.map +1 -0
- package/esm/models/publicperiodcoverage.js +17 -0
- package/esm/models/publicperiodcoverage.js.map +1 -0
- package/esm/models/publicperiodrates.d.ts +10 -0
- package/esm/models/publicperiodrates.d.ts.map +1 -0
- package/esm/models/publicperiodrates.js +14 -0
- package/esm/models/publicperiodrates.js.map +1 -0
- package/esm/models/publicpreviousvisibility.d.ts +10 -0
- package/esm/models/publicpreviousvisibility.d.ts.map +1 -0
- package/esm/models/publicpreviousvisibility.js +13 -0
- package/esm/models/publicpreviousvisibility.js.map +1 -0
- package/esm/models/publicpromptvisibilityreportresponse.d.ts +6 -0
- package/esm/models/publicpromptvisibilityreportresponse.d.ts.map +1 -1
- package/esm/models/publicpromptvisibilityreportresponse.js +6 -0
- package/esm/models/publicpromptvisibilityreportresponse.js.map +1 -1
- package/esm/models/publicratechanges.d.ts +8 -0
- package/esm/models/publicratechanges.d.ts.map +1 -0
- package/esm/models/publicratechanges.js +12 -0
- package/esm/models/publicratechanges.js.map +1 -0
- package/esm/models/publicrates.d.ts +27 -0
- package/esm/models/publicrates.d.ts.map +1 -0
- package/esm/models/publicrates.js +25 -0
- package/esm/models/publicrates.js.map +1 -0
- package/esm/models/publicresolvedperiod.d.ts +14 -0
- package/esm/models/publicresolvedperiod.d.ts.map +1 -0
- package/esm/models/publicresolvedperiod.js +18 -0
- package/esm/models/publicresolvedperiod.js.map +1 -0
- package/esm/models/publictopcitedurlsresponse.d.ts +10 -4
- package/esm/models/publictopcitedurlsresponse.d.ts.map +1 -1
- package/esm/models/publictopcitedurlsresponse.js +9 -3
- package/esm/models/publictopcitedurlsresponse.js.map +1 -1
- package/esm/models/publicvisibilityoverviewresponse.d.ts +6 -0
- package/esm/models/publicvisibilityoverviewresponse.d.ts.map +1 -1
- package/esm/models/publicvisibilityoverviewresponse.js +6 -0
- package/esm/models/publicvisibilityoverviewresponse.js.map +1 -1
- package/esm/models/updatev2promptrequest.js +1 -1
- package/esm/models/updatev2promptrequest.js.map +1 -1
- package/esm/models/v2agentanalyticscountrieslistop.d.ts +1 -0
- package/esm/models/v2agentanalyticscountrieslistop.d.ts.map +1 -1
- package/esm/models/v2agentanalyticscountrieslistop.js +1 -0
- package/esm/models/v2agentanalyticscountrieslistop.js.map +1 -1
- package/esm/models/v2agentanalyticserrorpageslistop.d.ts +1 -0
- package/esm/models/v2agentanalyticserrorpageslistop.d.ts.map +1 -1
- package/esm/models/v2agentanalyticserrorpageslistop.js +1 -0
- package/esm/models/v2agentanalyticserrorpageslistop.js.map +1 -1
- package/esm/models/v2agentanalyticspageslistop.d.ts +1 -0
- package/esm/models/v2agentanalyticspageslistop.d.ts.map +1 -1
- package/esm/models/v2agentanalyticspageslistop.js +1 -0
- package/esm/models/v2agentanalyticspageslistop.js.map +1 -1
- package/esm/models/v2agentanalyticssourceslistop.d.ts +1 -0
- package/esm/models/v2agentanalyticssourceslistop.d.ts.map +1 -1
- package/esm/models/v2agentanalyticssourceslistop.js +1 -0
- package/esm/models/v2agentanalyticssourceslistop.js.map +1 -1
- package/esm/models/v2agentanalyticssummaryretrieveop.d.ts +1 -0
- package/esm/models/v2agentanalyticssummaryretrieveop.d.ts.map +1 -1
- package/esm/models/v2agentanalyticssummaryretrieveop.js +1 -0
- package/esm/models/v2agentanalyticssummaryretrieveop.js.map +1 -1
- package/esm/models/v2promptrunscancelop.d.ts +38 -0
- package/esm/models/v2promptrunscancelop.d.ts.map +1 -0
- package/esm/models/v2promptrunscancelop.js +31 -0
- package/esm/models/v2promptrunscancelop.js.map +1 -0
- package/esm/models/v2visibilitycitationslistop.d.ts +1 -0
- package/esm/models/v2visibilitycitationslistop.d.ts.map +1 -1
- package/esm/models/v2visibilitycitationslistop.js +1 -0
- package/esm/models/v2visibilitycitationslistop.js.map +1 -1
- package/esm/models/v2visibilitycitationssummaryretrieveop.d.ts +54 -0
- package/esm/models/v2visibilitycitationssummaryretrieveop.d.ts.map +1 -0
- package/esm/models/v2visibilitycitationssummaryretrieveop.js +51 -0
- package/esm/models/v2visibilitycitationssummaryretrieveop.js.map +1 -0
- package/esm/models/v2visibilitycurrentretrieveop.d.ts +1 -0
- package/esm/models/v2visibilitycurrentretrieveop.d.ts.map +1 -1
- package/esm/models/v2visibilitycurrentretrieveop.js +1 -0
- package/esm/models/v2visibilitycurrentretrieveop.js.map +1 -1
- package/esm/models/v2visibilityoverviewretrieveop.d.ts +1 -0
- package/esm/models/v2visibilityoverviewretrieveop.d.ts.map +1 -1
- package/esm/models/v2visibilityoverviewretrieveop.js +1 -0
- package/esm/models/v2visibilityoverviewretrieveop.js.map +1 -1
- package/esm/models/v2visibilitypromptsretrieveop.d.ts +1 -0
- package/esm/models/v2visibilitypromptsretrieveop.d.ts.map +1 -1
- package/esm/models/v2visibilitypromptsretrieveop.js +1 -0
- package/esm/models/v2visibilitypromptsretrieveop.js.map +1 -1
- package/esm/tool-names.d.ts.map +1 -1
- package/esm/tool-names.js +16 -8
- package/esm/tool-names.js.map +1 -1
- package/package.json +1 -1
- package/src/funcs/agentAnalyticsCountriesList.ts +1 -0
- package/src/funcs/agentAnalyticsErrorPagesList.ts +1 -0
- package/src/funcs/agentAnalyticsPagesList.ts +1 -0
- package/src/funcs/agentAnalyticsSourcesList.ts +1 -0
- package/src/funcs/agentAnalyticsSummaryRetrieve.ts +2 -1
- package/src/funcs/agentsList.ts +1 -1
- package/src/funcs/evalsCreate.ts +2 -0
- package/src/funcs/evalsRun.ts +2 -0
- package/src/funcs/promptsRun.ts +7 -3
- package/src/funcs/promptsRunCancel.ts +153 -0
- package/src/funcs/visibilityCitationsList.ts +2 -1
- package/src/funcs/visibilityCitationsSummaryRetrieve.ts +158 -0
- package/src/funcs/visibilityCurrentRetrieve.ts +2 -1
- package/src/funcs/visibilityOverviewRetrieve.ts +2 -1
- package/src/funcs/visibilityPromptsRetrieve.ts +1 -0
- package/src/landing-page.ts +1 -1
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +4 -0
- package/src/mcp-server/tools/agentAnalyticsSummaryRetrieve.ts +1 -1
- package/src/mcp-server/tools/agentsList.ts +1 -1
- package/src/mcp-server/tools/evalsCreate.ts +3 -1
- package/src/mcp-server/tools/evalsRun.ts +2 -0
- package/src/mcp-server/tools/promptsRun.ts +7 -3
- package/src/mcp-server/tools/promptsRunCancel.ts +43 -0
- package/src/mcp-server/tools/visibilityCitationsList.ts +1 -1
- package/src/mcp-server/tools/visibilityCitationsSummaryRetrieve.ts +45 -0
- package/src/mcp-server/tools/visibilityCurrentRetrieve.ts +1 -1
- package/src/mcp-server/tools/visibilityOverviewRetrieve.ts +1 -1
- package/src/models/createv2promptrequest.ts +1 -1
- package/src/models/createv2promptrunrequest.ts +5 -1
- package/src/models/publicagentanalyticscountrylistresponse.ts +8 -0
- package/src/models/publicagentanalyticserrorpagelistresponse.ts +8 -0
- package/src/models/publicagentanalyticspagelistresponse.ts +8 -0
- package/src/models/publicagentanalyticssourcelistresponse.ts +8 -0
- package/src/models/publicagentanalyticssummary.ts +8 -0
- package/src/models/publiccitationsummarygroup.ts +54 -0
- package/src/models/publiccitationsummaryresponse.ts +110 -0
- package/src/models/publiccitationsummarytotals.ts +38 -0
- package/src/models/publiccoverage.ts +34 -0
- package/src/models/publiccoverageday.ts +68 -0
- package/src/models/publiccurrentvisibilityresponse.ts +26 -0
- package/src/models/publicperiodcoverage.ts +33 -0
- package/src/models/publicperiodrates.ts +29 -0
- package/src/models/publicpreviousvisibility.ts +30 -0
- package/src/models/publicpromptvisibilityreportresponse.ts +18 -0
- package/src/models/publicratechanges.ts +25 -0
- package/src/models/publicrates.ts +52 -0
- package/src/models/publicresolvedperiod.ts +41 -0
- package/src/models/publictopcitedurlsresponse.ts +25 -5
- package/src/models/publicvisibilityoverviewresponse.ts +18 -0
- package/src/models/updatev2promptrequest.ts +1 -1
- package/src/models/v2agentanalyticscountrieslistop.ts +4 -0
- package/src/models/v2agentanalyticserrorpageslistop.ts +4 -0
- package/src/models/v2agentanalyticspageslistop.ts +4 -0
- package/src/models/v2agentanalyticssourceslistop.ts +4 -0
- package/src/models/v2agentanalyticssummaryretrieveop.ts +4 -0
- package/src/models/v2promptrunscancelop.ts +90 -0
- package/src/models/v2visibilitycitationslistop.ts +4 -0
- package/src/models/v2visibilitycitationssummaryretrieveop.ts +113 -0
- package/src/models/v2visibilitycurrentretrieveop.ts +4 -0
- package/src/models/v2visibilityoverviewretrieveop.ts +4 -0
- package/src/models/v2visibilitypromptsretrieveop.ts +4 -0
- package/src/tool-names.ts +16 -8
package/esm/tool-names.js
CHANGED
|
@@ -10,20 +10,24 @@ export const toolNames = [
|
|
|
10
10
|
},
|
|
11
11
|
{
|
|
12
12
|
"name": "visibility-current-retrieve",
|
|
13
|
-
"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`."
|
|
13
|
+
"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."
|
|
14
14
|
},
|
|
15
15
|
{
|
|
16
16
|
"name": "visibility-overview-retrieve",
|
|
17
|
-
"description": "Retrieve Visibility Overview\n\nReturns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison. Calculated from active prompts only."
|
|
17
|
+
"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."
|
|
18
18
|
},
|
|
19
19
|
{
|
|
20
20
|
"name": "visibility-citations-list",
|
|
21
|
-
"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."
|
|
21
|
+
"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."
|
|
22
22
|
},
|
|
23
23
|
{
|
|
24
24
|
"name": "visibility-prompts-retrieve",
|
|
25
25
|
"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."
|
|
26
26
|
},
|
|
27
|
+
{
|
|
28
|
+
"name": "visibility-citations-summary-retrieve",
|
|
29
|
+
"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."
|
|
30
|
+
},
|
|
27
31
|
{
|
|
28
32
|
"name": "prompts-list",
|
|
29
33
|
"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 = [
|
|
|
70
74
|
},
|
|
71
75
|
{
|
|
72
76
|
"name": "prompts-run",
|
|
73
|
-
"description": "Run Prompts\n\nQueue saved prompts
|
|
77
|
+
"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`."
|
|
74
78
|
},
|
|
75
79
|
{
|
|
76
80
|
"name": "prompts-run-status",
|
|
77
81
|
"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`."
|
|
78
82
|
},
|
|
83
|
+
{
|
|
84
|
+
"name": "prompts-run-cancel",
|
|
85
|
+
"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."
|
|
86
|
+
},
|
|
79
87
|
{
|
|
80
88
|
"name": "opportunities-list",
|
|
81
89
|
"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 = [
|
|
|
114
122
|
},
|
|
115
123
|
{
|
|
116
124
|
"name": "agent-analytics-summary-retrieve",
|
|
117
|
-
"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."
|
|
125
|
+
"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`)."
|
|
118
126
|
},
|
|
119
127
|
{
|
|
120
128
|
"name": "agent-analytics-sources-list",
|
|
@@ -138,7 +146,7 @@ export const toolNames = [
|
|
|
138
146
|
},
|
|
139
147
|
{
|
|
140
148
|
"name": "evals-create",
|
|
141
|
-
"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."
|
|
149
|
+
"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."
|
|
142
150
|
},
|
|
143
151
|
{
|
|
144
152
|
"name": "evals-batch-create",
|
|
@@ -178,7 +186,7 @@ export const toolNames = [
|
|
|
178
186
|
},
|
|
179
187
|
{
|
|
180
188
|
"name": "evals-run",
|
|
181
|
-
"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."
|
|
189
|
+
"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."
|
|
182
190
|
},
|
|
183
191
|
{
|
|
184
192
|
"name": "evals-cancel",
|
|
@@ -250,7 +258,7 @@ export const toolNames = [
|
|
|
250
258
|
},
|
|
251
259
|
{
|
|
252
260
|
"name": "agents-list",
|
|
253
|
-
"description": "List Agents\n\nReturns the harness-and-model combinations your plan can run, as single agent IDs
|
|
261
|
+
"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."
|
|
254
262
|
},
|
|
255
263
|
{
|
|
256
264
|
"name": "repositories-list",
|
package/esm/tool-names.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tool-names.js","sourceRoot":"","sources":["../src/tool-names.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,MAAM,CAAC,MAAM,SAAS,GAAgD;IACpE;QACE,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,6GAA6G;KAC7H;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,aAAa,EAAE,0HAA0H;KAC1I;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,
|
|
1
|
+
{"version":3,"file":"tool-names.js","sourceRoot":"","sources":["../src/tool-names.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,MAAM,CAAC,MAAM,SAAS,GAAgD;IACpE;QACE,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,6GAA6G;KAC7H;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,aAAa,EAAE,0HAA0H;KAC1I;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,6YAA6Y;KAC7Z;IACD;QACE,MAAM,EAAE,8BAA8B;QACtC,aAAa,EAAE,qOAAqO;KACrP;IACD;QACE,MAAM,EAAE,2BAA2B;QACnC,aAAa,EAAE,wQAAwQ;KACxR;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,yLAAyL;KACzM;IACD;QACE,MAAM,EAAE,uCAAuC;QAC/C,aAAa,EAAE,4YAA4Y;KAC5Z;IACD;QACE,MAAM,EAAE,cAAc;QACtB,aAAa,EAAE,qHAAqH;KACrI;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,aAAa,EAAE,6JAA6J;KAC7K;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,aAAa,EAAE,yEAAyE;KACzF;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,qEAAqE;KACrF;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,uEAAuE;KACvF;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,wJAAwJ;KACxK;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,aAAa,EAAE,qLAAqL;KACrM;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,iJAAiJ;KACjK;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,aAAa,EAAE,uHAAuH;KACvI;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,aAAa,EAAE,8IAA8I;KAC9J;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,aAAa,EAAE,qHAAqH;KACrI;IACD;QACE,MAAM,EAAE,aAAa;QACrB,aAAa,EAAE,ymBAAymB;KACznB;IACD;QACE,MAAM,EAAE,oBAAoB;QAC5B,aAAa,EAAE,mOAAmO;KACnP;IACD;QACE,MAAM,EAAE,oBAAoB;QAC5B,aAAa,EAAE,8iBAA8iB;KAC9jB;IACD;QACE,MAAM,EAAE,oBAAoB;QAC5B,aAAa,EAAE,iMAAiM;KACjN;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,aAAa,EAAE,kHAAkH;KAClI;IACD;QACE,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,0IAA0I;KAC1J;IACD;QACE,MAAM,EAAE,cAAc;QACtB,aAAa,EAAE,iHAAiH;KACjI;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,aAAa,EAAE,uEAAuE;KACvF;IACD;QACE,MAAM,EAAE,cAAc;QACtB,aAAa,EAAE,4IAA4I;KAC5J;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,aAAa,EAAE,6NAA6N;KAC7O;IACD;QACE,MAAM,EAAE,sBAAsB;QAC9B,aAAa,EAAE,uHAAuH;KACvI;IACD;QACE,MAAM,EAAE,4BAA4B;QACpC,aAAa,EAAE,yIAAyI;KACzJ;IACD;QACE,MAAM,EAAE,kCAAkC;QAC1C,aAAa,EAAE,mUAAmU;KACnV;IACD;QACE,MAAM,EAAE,8BAA8B;QACtC,aAAa,EAAE,wMAAwM;KACxN;IACD;QACE,MAAM,EAAE,4BAA4B;QACpC,aAAa,EAAE,0SAA0S;KAC1T;IACD;QACE,MAAM,EAAE,kCAAkC;QAC1C,aAAa,EAAE,gXAAgX;KAChY;IACD;QACE,MAAM,EAAE,gCAAgC;QACxC,aAAa,EAAE,kJAAkJ;KAClK;IACD;QACE,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,wKAAwK;KACxL;IACD;QACE,MAAM,EAAE,cAAc;QACtB,aAAa,EAAE,4qBAA4qB;KAC5rB;IACD;QACE,MAAM,EAAE,oBAAoB;QAC5B,aAAa,EAAE,2wBAA2wB;KAC3xB;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,aAAa,EAAE,mEAAmE;KACnF;IACD;QACE,MAAM,EAAE,cAAc;QACtB,aAAa,EAAE,6PAA6P;KAC7Q;IACD;QACE,MAAM,EAAE,cAAc;QACtB,aAAa,EAAE,iFAAiF;KACjG;IACD;QACE,MAAM,EAAE,2BAA2B;QACnC,aAAa,EAAE,sIAAsI;KACtJ;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,sIAAsI;KACtJ;IACD;QACE,MAAM,EAAE,+BAA+B;QACvC,aAAa,EAAE,wEAAwE;KACxF;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,yFAAyF;KACzG;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,qGAAqG;KACrH;IACD;QACE,MAAM,EAAE,WAAW;QACnB,aAAa,EAAE,45CAA45C;KAC56C;IACD;QACE,MAAM,EAAE,cAAc;QACtB,aAAa,EAAE,4VAA4V;KAC5W;IACD;QACE,MAAM,EAAE,aAAa;QACrB,aAAa,EAAE,+NAA+N;KAC/O;IACD;QACE,MAAM,EAAE,WAAW;QACnB,aAAa,EAAE,sTAAsT;KACtU;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,aAAa,EAAE,yKAAyK;KACzL;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,ofAAof;KACpgB;IACD;QACE,MAAM,EAAE,yBAAyB;QACjC,aAAa,EAAE,yEAAyE;KACzF;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,kKAAkK;KAClL;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,oKAAoK;KACpL;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,aAAa,EAAE,oPAAoP;KACpQ;IACD;QACE,MAAM,EAAE,mCAAmC;QAC3C,aAAa,EAAE,0KAA0K;KAC1L;IACD;QACE,MAAM,EAAE,wCAAwC;QAChD,aAAa,EAAE,uUAAuU;KACvV;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,oFAAoF;KACpG;IACD;QACE,MAAM,EAAE,+BAA+B;QACvC,aAAa,EAAE,qSAAqS;KACrT;IACD;QACE,MAAM,EAAE,iCAAiC;QACzC,aAAa,EAAE,qDAAqD;KACrE;IACD;QACE,MAAM,EAAE,+BAA+B;QACvC,aAAa,EAAE,sQAAsQ;KACtR;IACD;QACE,MAAM,EAAE,+BAA+B;QACvC,aAAa,EAAE,+FAA+F;KAC/G;IACD;QACE,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,iKAAiK;KACjL;IACD;QACE,MAAM,EAAE,aAAa;QACrB,aAAa,EAAE,+bAA+b;KAC/c;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,aAAa,EAAE,6OAA6O;KAC7P;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,aAAa,EAAE,wFAAwF;KACxG;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,mEAAmE;KACnF;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,aAAa,EAAE,uFAAuF;KACvG;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,aAAa,EAAE,mGAAmG;KACnH;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,aAAa,EAAE,oFAAoF;KACpG;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,aAAa,EAAE,iGAAiG;KACjH;IACD;QACE,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,qFAAqF;KACrG;IACD;QACE,MAAM,EAAE,aAAa;QACrB,aAAa,EAAE,wFAAwF;KACxG;CACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
|
|
|
30
30
|
* Retrieve Agent Analytics Summary
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Returns 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.
|
|
33
|
+
* Returns 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`).
|
|
34
34
|
*/
|
|
35
35
|
export function agentAnalyticsSummaryRetrieve(
|
|
36
36
|
client$: LightsageMcpCore,
|
|
@@ -96,6 +96,7 @@ async function $do(
|
|
|
96
96
|
);
|
|
97
97
|
const query$ = encodeFormQuery({
|
|
98
98
|
"end_date": payload$.end_date,
|
|
99
|
+
"period": payload$.period,
|
|
99
100
|
"start_date": payload$.start_date,
|
|
100
101
|
});
|
|
101
102
|
|
package/src/funcs/agentsList.ts
CHANGED
|
@@ -24,7 +24,7 @@ import { Result } from "../types/fp.js";
|
|
|
24
24
|
* List Agents
|
|
25
25
|
*
|
|
26
26
|
* @remarks
|
|
27
|
-
* Returns the harness-and-model combinations your plan can run, as single agent IDs
|
|
27
|
+
* Returns 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.
|
|
28
28
|
*/
|
|
29
29
|
export function agentsList(
|
|
30
30
|
client$: LightsageMcpCore,
|
package/src/funcs/evalsCreate.ts
CHANGED
|
@@ -31,6 +31,8 @@ import { Result } from "../types/fp.js";
|
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
33
|
* Creates 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.
|
|
34
|
+
*
|
|
35
|
+
* Evals 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.
|
|
34
36
|
*/
|
|
35
37
|
export function evalsCreate(
|
|
36
38
|
client$: LightsageMcpCore,
|
package/src/funcs/evalsRun.ts
CHANGED
|
@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
|
|
|
32
32
|
* @remarks
|
|
33
33
|
* Queues 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.
|
|
34
34
|
*
|
|
35
|
+
* Eval 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.
|
|
36
|
+
*
|
|
35
37
|
* Send one of these flat request forms:
|
|
36
38
|
*
|
|
37
39
|
* - **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.
|
package/src/funcs/promptsRun.ts
CHANGED
|
@@ -30,11 +30,15 @@ import { Result } from "../types/fp.js";
|
|
|
30
30
|
* Run Prompts
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Queue saved prompts
|
|
33
|
+
* Queue saved prompts on answer engines and coding agents.
|
|
34
34
|
*
|
|
35
35
|
* Provide `prompt_ids` to run selected prompts, or omit them to run all active
|
|
36
|
-
* prompts.
|
|
37
|
-
*
|
|
36
|
+
* prompts. By default the run uses the organization's configured targets.
|
|
37
|
+
* Provide `agent` with IDs from `GET /v2/agents` to run the prompts on
|
|
38
|
+
* specific coding-agent harnesses and models instead, for example to compare
|
|
39
|
+
* how several coding tools answer the same developer question. Results
|
|
40
|
+
* include mentions and citations. Saved prompt run settings apply to
|
|
41
|
+
* coding-agent targets. The response returns a run ID to poll with
|
|
38
42
|
* `GET /v2/prompts/runs/{run_id}/status`.
|
|
39
43
|
*/
|
|
40
44
|
export function promptsRun(
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: ebd8b3d30dc1
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import { LightsageMcpCore } from "../core.js";
|
|
7
|
+
import { encodeSimple } from "../lib/encodings.js";
|
|
8
|
+
import { compactMap } from "../lib/primitives.js";
|
|
9
|
+
import { safeParse } from "../lib/schemas.js";
|
|
10
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
11
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
12
|
+
import { pathToFunc } from "../lib/url.js";
|
|
13
|
+
import { APIError } from "../models/errors/apierror.js";
|
|
14
|
+
import {
|
|
15
|
+
ConnectionError,
|
|
16
|
+
InvalidRequestError,
|
|
17
|
+
RequestAbortedError,
|
|
18
|
+
RequestTimeoutError,
|
|
19
|
+
UnexpectedClientError,
|
|
20
|
+
} from "../models/errors/httpclienterrors.js";
|
|
21
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
22
|
+
import {
|
|
23
|
+
V2PromptRunsCancelRequest,
|
|
24
|
+
V2PromptRunsCancelRequest$zodSchema,
|
|
25
|
+
} from "../models/v2promptrunscancelop.js";
|
|
26
|
+
import { APICall, APIPromise } from "../types/async.js";
|
|
27
|
+
import { Result } from "../types/fp.js";
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Cancel a prompt run
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Marks 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.
|
|
34
|
+
*/
|
|
35
|
+
export function promptsRunCancel(
|
|
36
|
+
client$: LightsageMcpCore,
|
|
37
|
+
request: V2PromptRunsCancelRequest,
|
|
38
|
+
options?: RequestOptions,
|
|
39
|
+
): APIPromise<
|
|
40
|
+
Result<
|
|
41
|
+
Response,
|
|
42
|
+
| APIError
|
|
43
|
+
| SDKValidationError
|
|
44
|
+
| UnexpectedClientError
|
|
45
|
+
| InvalidRequestError
|
|
46
|
+
| RequestAbortedError
|
|
47
|
+
| RequestTimeoutError
|
|
48
|
+
| ConnectionError
|
|
49
|
+
>
|
|
50
|
+
> {
|
|
51
|
+
return new APIPromise($do(
|
|
52
|
+
client$,
|
|
53
|
+
request,
|
|
54
|
+
options,
|
|
55
|
+
));
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
async function $do(
|
|
59
|
+
client$: LightsageMcpCore,
|
|
60
|
+
request: V2PromptRunsCancelRequest,
|
|
61
|
+
options?: RequestOptions,
|
|
62
|
+
): Promise<
|
|
63
|
+
[
|
|
64
|
+
Result<
|
|
65
|
+
Response,
|
|
66
|
+
| APIError
|
|
67
|
+
| SDKValidationError
|
|
68
|
+
| UnexpectedClientError
|
|
69
|
+
| InvalidRequestError
|
|
70
|
+
| RequestAbortedError
|
|
71
|
+
| RequestTimeoutError
|
|
72
|
+
| ConnectionError
|
|
73
|
+
>,
|
|
74
|
+
APICall,
|
|
75
|
+
]
|
|
76
|
+
> {
|
|
77
|
+
const parsed$ = safeParse(
|
|
78
|
+
request,
|
|
79
|
+
(value$) => V2PromptRunsCancelRequest$zodSchema.parse(value$),
|
|
80
|
+
"Input validation failed",
|
|
81
|
+
);
|
|
82
|
+
if (!parsed$.ok) {
|
|
83
|
+
return [parsed$, { status: "invalid" }];
|
|
84
|
+
}
|
|
85
|
+
const payload$ = parsed$.value;
|
|
86
|
+
const body$ = null;
|
|
87
|
+
|
|
88
|
+
const pathParams$ = {
|
|
89
|
+
run_id: encodeSimple("run_id", payload$.run_id, {
|
|
90
|
+
explode: false,
|
|
91
|
+
charEncoding: "percent",
|
|
92
|
+
}),
|
|
93
|
+
};
|
|
94
|
+
const path$ = pathToFunc("/v2/prompts/runs/{run_id}/cancel")(
|
|
95
|
+
pathParams$,
|
|
96
|
+
);
|
|
97
|
+
|
|
98
|
+
const headers$ = new Headers(compactMap({
|
|
99
|
+
Accept: "application/json",
|
|
100
|
+
}));
|
|
101
|
+
const securityInput = await extractSecurity(client$._options.security);
|
|
102
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
103
|
+
|
|
104
|
+
const context = {
|
|
105
|
+
options: client$._options,
|
|
106
|
+
baseURL: options?.serverURL ?? client$._baseURL ?? "",
|
|
107
|
+
operationID: "v2_prompt_runs_cancel",
|
|
108
|
+
oAuth2Scopes: null,
|
|
109
|
+
resolvedSecurity: requestSecurity,
|
|
110
|
+
securitySource: client$._options.security,
|
|
111
|
+
retryConfig: options?.retries
|
|
112
|
+
|| client$._options.retryConfig
|
|
113
|
+
|| { strategy: "none" },
|
|
114
|
+
retryCodes: options?.retryCodes || [
|
|
115
|
+
"429",
|
|
116
|
+
"500",
|
|
117
|
+
"502",
|
|
118
|
+
"503",
|
|
119
|
+
"504",
|
|
120
|
+
],
|
|
121
|
+
};
|
|
122
|
+
|
|
123
|
+
const requestRes = client$._createRequest(context, {
|
|
124
|
+
security: requestSecurity,
|
|
125
|
+
method: "POST",
|
|
126
|
+
baseURL: options?.serverURL,
|
|
127
|
+
path: path$,
|
|
128
|
+
headers: headers$,
|
|
129
|
+
body: body$,
|
|
130
|
+
userAgent: client$._options.userAgent,
|
|
131
|
+
timeoutMs: options?.timeoutMs || client$._options.timeoutMs
|
|
132
|
+
|| -1,
|
|
133
|
+
}, options);
|
|
134
|
+
if (!requestRes.ok) {
|
|
135
|
+
return [requestRes, { status: "invalid" }];
|
|
136
|
+
}
|
|
137
|
+
const req$ = requestRes.value;
|
|
138
|
+
|
|
139
|
+
const doResult = await client$._do(req$, {
|
|
140
|
+
context,
|
|
141
|
+
errorCodes: [],
|
|
142
|
+
retryConfig: context.retryConfig,
|
|
143
|
+
retryCodes: context.retryCodes,
|
|
144
|
+
});
|
|
145
|
+
if (!doResult.ok) {
|
|
146
|
+
return [doResult, { status: "request-error", request: req$ }];
|
|
147
|
+
}
|
|
148
|
+
return [doResult, {
|
|
149
|
+
status: "complete",
|
|
150
|
+
"request": req$,
|
|
151
|
+
response: doResult.value,
|
|
152
|
+
}];
|
|
153
|
+
}
|
|
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
|
|
|
30
30
|
* List Top Cited Urls
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Returns URL-level citation counts ranked from most to least cited. Results can be filtered by platform and to owned or external sources.
|
|
33
|
+
* Returns 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.
|
|
34
34
|
*/
|
|
35
35
|
export function visibilityCitationsList(
|
|
36
36
|
client$: LightsageMcpCore,
|
|
@@ -89,6 +89,7 @@ async function $do(
|
|
|
89
89
|
const query$ = encodeFormQuery({
|
|
90
90
|
"end_date": payload$?.end_date,
|
|
91
91
|
"limit": payload$?.limit,
|
|
92
|
+
"period": payload$?.period,
|
|
92
93
|
"platform": payload$?.platform,
|
|
93
94
|
"source_type": payload$?.source_type,
|
|
94
95
|
"start_date": payload$?.start_date,
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: ce453917507f
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import { LightsageMcpCore } from "../core.js";
|
|
7
|
+
import { encodeFormQuery } from "../lib/encodings.js";
|
|
8
|
+
import { compactMap } from "../lib/primitives.js";
|
|
9
|
+
import { safeParse } from "../lib/schemas.js";
|
|
10
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
11
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
12
|
+
import { pathToFunc } from "../lib/url.js";
|
|
13
|
+
import { APIError } from "../models/errors/apierror.js";
|
|
14
|
+
import {
|
|
15
|
+
ConnectionError,
|
|
16
|
+
InvalidRequestError,
|
|
17
|
+
RequestAbortedError,
|
|
18
|
+
RequestTimeoutError,
|
|
19
|
+
UnexpectedClientError,
|
|
20
|
+
} from "../models/errors/httpclienterrors.js";
|
|
21
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
22
|
+
import {
|
|
23
|
+
V2VisibilityCitationsSummaryRetrieveRequest,
|
|
24
|
+
V2VisibilityCitationsSummaryRetrieveRequest$zodSchema,
|
|
25
|
+
} from "../models/v2visibilitycitationssummaryretrieveop.js";
|
|
26
|
+
import { APICall, APIPromise } from "../types/async.js";
|
|
27
|
+
import { Result } from "../types/fp.js";
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Retrieve Citation Summary
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Returns 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.
|
|
34
|
+
*/
|
|
35
|
+
export function visibilityCitationsSummaryRetrieve(
|
|
36
|
+
client$: LightsageMcpCore,
|
|
37
|
+
request?: V2VisibilityCitationsSummaryRetrieveRequest | undefined,
|
|
38
|
+
options?: RequestOptions,
|
|
39
|
+
): APIPromise<
|
|
40
|
+
Result<
|
|
41
|
+
Response,
|
|
42
|
+
| APIError
|
|
43
|
+
| SDKValidationError
|
|
44
|
+
| UnexpectedClientError
|
|
45
|
+
| InvalidRequestError
|
|
46
|
+
| RequestAbortedError
|
|
47
|
+
| RequestTimeoutError
|
|
48
|
+
| ConnectionError
|
|
49
|
+
>
|
|
50
|
+
> {
|
|
51
|
+
return new APIPromise($do(
|
|
52
|
+
client$,
|
|
53
|
+
request,
|
|
54
|
+
options,
|
|
55
|
+
));
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
async function $do(
|
|
59
|
+
client$: LightsageMcpCore,
|
|
60
|
+
request?: V2VisibilityCitationsSummaryRetrieveRequest | undefined,
|
|
61
|
+
options?: RequestOptions,
|
|
62
|
+
): Promise<
|
|
63
|
+
[
|
|
64
|
+
Result<
|
|
65
|
+
Response,
|
|
66
|
+
| APIError
|
|
67
|
+
| SDKValidationError
|
|
68
|
+
| UnexpectedClientError
|
|
69
|
+
| InvalidRequestError
|
|
70
|
+
| RequestAbortedError
|
|
71
|
+
| RequestTimeoutError
|
|
72
|
+
| ConnectionError
|
|
73
|
+
>,
|
|
74
|
+
APICall,
|
|
75
|
+
]
|
|
76
|
+
> {
|
|
77
|
+
const parsed$ = safeParse(
|
|
78
|
+
request,
|
|
79
|
+
(value$) =>
|
|
80
|
+
V2VisibilityCitationsSummaryRetrieveRequest$zodSchema.optional().parse(
|
|
81
|
+
value$,
|
|
82
|
+
),
|
|
83
|
+
"Input validation failed",
|
|
84
|
+
);
|
|
85
|
+
if (!parsed$.ok) {
|
|
86
|
+
return [parsed$, { status: "invalid" }];
|
|
87
|
+
}
|
|
88
|
+
const payload$ = parsed$.value;
|
|
89
|
+
const body$ = null;
|
|
90
|
+
const path$ = pathToFunc("/v2/visibility/citations/summary")();
|
|
91
|
+
const query$ = encodeFormQuery({
|
|
92
|
+
"end_date": payload$?.end_date,
|
|
93
|
+
"group_by": payload$?.group_by,
|
|
94
|
+
"limit": payload$?.limit,
|
|
95
|
+
"period": payload$?.period,
|
|
96
|
+
"platform": payload$?.platform,
|
|
97
|
+
"source_type": payload$?.source_type,
|
|
98
|
+
"start_date": payload$?.start_date,
|
|
99
|
+
"url_prefix": payload$?.url_prefix,
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
const headers$ = new Headers(compactMap({
|
|
103
|
+
Accept: "application/json",
|
|
104
|
+
}));
|
|
105
|
+
const securityInput = await extractSecurity(client$._options.security);
|
|
106
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
107
|
+
|
|
108
|
+
const context = {
|
|
109
|
+
options: client$._options,
|
|
110
|
+
baseURL: options?.serverURL ?? client$._baseURL ?? "",
|
|
111
|
+
operationID: "v2_visibility_citations_summary_retrieve",
|
|
112
|
+
oAuth2Scopes: null,
|
|
113
|
+
resolvedSecurity: requestSecurity,
|
|
114
|
+
securitySource: client$._options.security,
|
|
115
|
+
retryConfig: options?.retries
|
|
116
|
+
|| client$._options.retryConfig
|
|
117
|
+
|| { strategy: "none" },
|
|
118
|
+
retryCodes: options?.retryCodes || [
|
|
119
|
+
"429",
|
|
120
|
+
"500",
|
|
121
|
+
"502",
|
|
122
|
+
"503",
|
|
123
|
+
"504",
|
|
124
|
+
],
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
const requestRes = client$._createRequest(context, {
|
|
128
|
+
security: requestSecurity,
|
|
129
|
+
method: "GET",
|
|
130
|
+
baseURL: options?.serverURL,
|
|
131
|
+
path: path$,
|
|
132
|
+
headers: headers$,
|
|
133
|
+
query: query$,
|
|
134
|
+
body: body$,
|
|
135
|
+
userAgent: client$._options.userAgent,
|
|
136
|
+
timeoutMs: options?.timeoutMs || client$._options.timeoutMs
|
|
137
|
+
|| -1,
|
|
138
|
+
}, options);
|
|
139
|
+
if (!requestRes.ok) {
|
|
140
|
+
return [requestRes, { status: "invalid" }];
|
|
141
|
+
}
|
|
142
|
+
const req$ = requestRes.value;
|
|
143
|
+
|
|
144
|
+
const doResult = await client$._do(req$, {
|
|
145
|
+
context,
|
|
146
|
+
errorCodes: [],
|
|
147
|
+
retryConfig: context.retryConfig,
|
|
148
|
+
retryCodes: context.retryCodes,
|
|
149
|
+
});
|
|
150
|
+
if (!doResult.ok) {
|
|
151
|
+
return [doResult, { status: "request-error", request: req$ }];
|
|
152
|
+
}
|
|
153
|
+
return [doResult, {
|
|
154
|
+
status: "complete",
|
|
155
|
+
"request": req$,
|
|
156
|
+
response: doResult.value,
|
|
157
|
+
}];
|
|
158
|
+
}
|
|
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
|
|
|
30
30
|
* Retrieve Current Visibility
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Returns 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`.
|
|
33
|
+
* Returns 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.
|
|
34
34
|
*/
|
|
35
35
|
export function visibilityCurrentRetrieve(
|
|
36
36
|
client$: LightsageMcpCore,
|
|
@@ -88,6 +88,7 @@ async function $do(
|
|
|
88
88
|
const path$ = pathToFunc("/v2/visibility/current")();
|
|
89
89
|
const query$ = encodeFormQuery({
|
|
90
90
|
"end_date": payload$?.end_date,
|
|
91
|
+
"period": payload$?.period,
|
|
91
92
|
"start_date": payload$?.start_date,
|
|
92
93
|
});
|
|
93
94
|
|
|
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
|
|
|
30
30
|
* Retrieve Visibility Overview
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Returns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison. Calculated from active prompts only.
|
|
33
|
+
* Returns 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.
|
|
34
34
|
*/
|
|
35
35
|
export function visibilityOverviewRetrieve(
|
|
36
36
|
client$: LightsageMcpCore,
|
|
@@ -88,6 +88,7 @@ async function $do(
|
|
|
88
88
|
const path$ = pathToFunc("/v2/visibility/overview")();
|
|
89
89
|
const query$ = encodeFormQuery({
|
|
90
90
|
"end_date": payload$?.end_date,
|
|
91
|
+
"period": payload$?.period,
|
|
91
92
|
"start_date": payload$?.start_date,
|
|
92
93
|
});
|
|
93
94
|
|
package/src/landing-page.ts
CHANGED
|
@@ -931,7 +931,7 @@ http_headers = { "lightsage-api-key-auth" = "YOUR_LIGHTSAGE_API_KEY_AUTH" }`;
|
|
|
931
931
|
<h1>Instructions</h1>
|
|
932
932
|
<p>One-click installation for Claude Desktop users</p>
|
|
933
933
|
<div class="instruction-item">
|
|
934
|
-
<a href="https://github.com/lightsagehq/mcp/releases/download/v0.4.
|
|
934
|
+
<a href="https://github.com/lightsagehq/mcp/releases/download/v0.4.18/mcp-server.mcpb" download="mcp-server.mcpb" class="action-button header-action" style="display: inline-flex; margin-bottom: 16px;">
|
|
935
935
|
📥 Download MCP Bundle
|
|
936
936
|
</a>
|
|
937
937
|
</div>
|
package/src/lib/config.ts
CHANGED
|
@@ -66,7 +66,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
|
|
|
66
66
|
export const SDK_METADATA = {
|
|
67
67
|
language: "typescript",
|
|
68
68
|
openapiDocVersion: "1.0.0",
|
|
69
|
-
sdkVersion: "0.4.
|
|
69
|
+
sdkVersion: "0.4.18",
|
|
70
70
|
genVersion: "2.948.4",
|
|
71
|
-
userAgent: "speakeasy-sdk/mcp-typescript 0.4.
|
|
71
|
+
userAgent: "speakeasy-sdk/mcp-typescript 0.4.18 2.948.4 1.0.0 @lightsage/mcp",
|
|
72
72
|
} as const;
|