@cesteral/linkedin-mcp 1.0.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/LICENSE.md +201 -0
- package/README.md +304 -0
- package/dist/auth/index.d.ts +3 -0
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/index.js +3 -0
- package/dist/auth/index.js.map +1 -0
- package/dist/auth/linkedin-auth-adapter.d.ts +38 -0
- package/dist/auth/linkedin-auth-adapter.d.ts.map +1 -0
- package/dist/auth/linkedin-auth-adapter.js +110 -0
- package/dist/auth/linkedin-auth-adapter.js.map +1 -0
- package/dist/auth/linkedin-auth-strategy.d.ts +14 -0
- package/dist/auth/linkedin-auth-strategy.d.ts.map +1 -0
- package/dist/auth/linkedin-auth-strategy.js +50 -0
- package/dist/auth/linkedin-auth-strategy.js.map +1 -0
- package/dist/config/index.d.ts +100 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +37 -0
- package/dist/config/index.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +40 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/analytics-reporting-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/analytics-reporting-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/analytics-reporting-workflow.prompt.js +108 -0
- package/dist/mcp-server/prompts/definitions/analytics-reporting-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.js +177 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.js +171 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.js +109 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.js +299 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.js +170 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.js +213 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.js +151 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.js +217 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.js +98 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.js +91 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/index.d.ts +9 -0
- package/dist/mcp-server/prompts/index.d.ts.map +1 -0
- package/dist/mcp-server/prompts/index.js +97 -0
- package/dist/mcp-server/prompts/index.js.map +1 -0
- package/dist/mcp-server/resources/definitions/analytics-reference.resource.d.ts +3 -0
- package/dist/mcp-server/resources/definitions/analytics-reference.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/analytics-reference.resource.js +162 -0
- package/dist/mcp-server/resources/definitions/analytics-reference.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.d.ts +4 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.js +164 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.d.ts +3 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.js +144 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.d.ts +4 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.js +127 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/index.d.ts +8 -0
- package/dist/mcp-server/resources/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/index.js +54 -0
- package/dist/mcp-server/resources/definitions/index.js.map +1 -0
- package/dist/mcp-server/resources/definitions/targeting-reference.resource.d.ts +3 -0
- package/dist/mcp-server/resources/definitions/targeting-reference.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/targeting-reference.resource.js +122 -0
- package/dist/mcp-server/resources/definitions/targeting-reference.resource.js.map +1 -0
- package/dist/mcp-server/resources/index.d.ts +3 -0
- package/dist/mcp-server/resources/index.d.ts.map +1 -0
- package/dist/mcp-server/resources/index.js +2 -0
- package/dist/mcp-server/resources/index.js.map +1 -0
- package/dist/mcp-server/resources/types.d.ts +8 -0
- package/dist/mcp-server/resources/types.d.ts.map +1 -0
- package/dist/mcp-server/resources/types.js +2 -0
- package/dist/mcp-server/resources/types.js.map +1 -0
- package/dist/mcp-server/server.d.ts +5 -0
- package/dist/mcp-server/server.d.ts.map +1 -0
- package/dist/mcp-server/server.js +128 -0
- package/dist/mcp-server/server.js.map +1 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.d.ts +213 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.js +174 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.d.ts +128 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.js +95 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.d.ts +183 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.js +122 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.d.ts +140 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.js +109 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.d.ts +117 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.js +98 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.d.ts +93 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.js +100 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.d.ts +95 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.js +89 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.d.ts +75 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.js +68 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-previews.tool.d.ts +75 -0
- package/dist/mcp-server/tools/definitions/get-ad-previews.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-previews.tool.js +71 -0
- package/dist/mcp-server/tools/definitions/get-ad-previews.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-analytics-breakdowns.tool.d.ts +223 -0
- package/dist/mcp-server/tools/definitions/get-analytics-breakdowns.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-analytics-breakdowns.tool.js +152 -0
- package/dist/mcp-server/tools/definitions/get-analytics-breakdowns.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-analytics.tool.d.ts +325 -0
- package/dist/mcp-server/tools/definitions/get-analytics.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-analytics.tool.js +154 -0
- package/dist/mcp-server/tools/definitions/get-analytics.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-delivery-forecast.tool.d.ts +95 -0
- package/dist/mcp-server/tools/definitions/get-delivery-forecast.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-delivery-forecast.tool.js +90 -0
- package/dist/mcp-server/tools/definitions/get-delivery-forecast.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.d.ts +75 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.js +75 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.d.ts +81 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.js +76 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/index.d.ts +23 -0
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/index.js +69 -0
- package/dist/mcp-server/tools/definitions/index.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-ad-accounts.tool.d.ts +141 -0
- package/dist/mcp-server/tools/definitions/list-ad-accounts.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-ad-accounts.tool.js +84 -0
- package/dist/mcp-server/tools/definitions/list-ad-accounts.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.d.ts +165 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.js +112 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.d.ts +102 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.js +98 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.d.ts +104 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.js +88 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.d.ts +75 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.js +99 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.d.ts +69 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.js +98 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.d.ts +168 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.js +200 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/index.d.ts +2 -0
- package/dist/mcp-server/tools/index.d.ts.map +1 -0
- package/dist/mcp-server/tools/index.js +2 -0
- package/dist/mcp-server/tools/index.js.map +1 -0
- package/dist/mcp-server/tools/utils/entity-mapping.d.ts +13 -0
- package/dist/mcp-server/tools/utils/entity-mapping.d.ts.map +1 -0
- package/dist/mcp-server/tools/utils/entity-mapping.js +68 -0
- package/dist/mcp-server/tools/utils/entity-mapping.js.map +1 -0
- package/dist/mcp-server/tools/utils/media-types.d.ts +12 -0
- package/dist/mcp-server/tools/utils/media-types.d.ts.map +1 -0
- package/dist/mcp-server/tools/utils/media-types.js +2 -0
- package/dist/mcp-server/tools/utils/media-types.js.map +1 -0
- package/dist/mcp-server/tools/utils/resolve-session.d.ts +4 -0
- package/dist/mcp-server/tools/utils/resolve-session.d.ts.map +1 -0
- package/dist/mcp-server/tools/utils/resolve-session.js +6 -0
- package/dist/mcp-server/tools/utils/resolve-session.js.map +1 -0
- package/dist/mcp-server/transports/streamable-http-transport.d.ts +49 -0
- package/dist/mcp-server/transports/streamable-http-transport.d.ts.map +1 -0
- package/dist/mcp-server/transports/streamable-http-transport.js +91 -0
- package/dist/mcp-server/transports/streamable-http-transport.js.map +1 -0
- package/dist/services/linkedin/linkedin-http-client.d.ts +20 -0
- package/dist/services/linkedin/linkedin-http-client.d.ts.map +1 -0
- package/dist/services/linkedin/linkedin-http-client.js +147 -0
- package/dist/services/linkedin/linkedin-http-client.js.map +1 -0
- package/dist/services/linkedin/linkedin-reporting-service.d.ts +26 -0
- package/dist/services/linkedin/linkedin-reporting-service.d.ts.map +1 -0
- package/dist/services/linkedin/linkedin-reporting-service.js +69 -0
- package/dist/services/linkedin/linkedin-reporting-service.js.map +1 -0
- package/dist/services/linkedin/linkedin-service.d.ts +84 -0
- package/dist/services/linkedin/linkedin-service.d.ts.map +1 -0
- package/dist/services/linkedin/linkedin-service.js +195 -0
- package/dist/services/linkedin/linkedin-service.js.map +1 -0
- package/dist/services/linkedin/types.d.ts +166 -0
- package/dist/services/linkedin/types.d.ts.map +1 -0
- package/dist/services/linkedin/types.js +31 -0
- package/dist/services/linkedin/types.js.map +1 -0
- package/dist/services/session-services.d.ts +18 -0
- package/dist/services/session-services.d.ts.map +1 -0
- package/dist/services/session-services.js +16 -0
- package/dist/services/session-services.js.map +1 -0
- package/dist/types-global/mcp.d.ts +2 -0
- package/dist/types-global/mcp.d.ts.map +1 -0
- package/dist/types-global/mcp.js +2 -0
- package/dist/types-global/mcp.js.map +1 -0
- package/dist/utils/errors/index.d.ts +2 -0
- package/dist/utils/errors/index.d.ts.map +1 -0
- package/dist/utils/errors/index.js +2 -0
- package/dist/utils/errors/index.js.map +1 -0
- package/dist/utils/platform.d.ts +3 -0
- package/dist/utils/platform.d.ts.map +1 -0
- package/dist/utils/platform.js +5 -0
- package/dist/utils/platform.js.map +1 -0
- package/dist/utils/security/rate-limiter.d.ts +3 -0
- package/dist/utils/security/rate-limiter.d.ts.map +1 -0
- package/dist/utils/security/rate-limiter.js +5 -0
- package/dist/utils/security/rate-limiter.js.map +1 -0
- package/dist/utils/telemetry/index.d.ts +2 -0
- package/dist/utils/telemetry/index.d.ts.map +1 -0
- package/dist/utils/telemetry/index.js +2 -0
- package/dist/utils/telemetry/index.js.map +1 -0
- package/dist/utils/telemetry/tracing.d.ts +3 -0
- package/dist/utils/telemetry/tracing.d.ts.map +1 -0
- package/dist/utils/telemetry/tracing.js +4 -0
- package/dist/utils/telemetry/tracing.js.map +1 -0
- package/package.json +55 -0
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { resolveSessionServices } from "../utils/resolve-session.js";
|
|
3
|
+
const TOOL_NAME = "linkedin_get_ad_previews";
|
|
4
|
+
const TOOL_TITLE = "Get LinkedIn Ads Ad Preview";
|
|
5
|
+
const TOOL_DESCRIPTION = `Get a preview of a LinkedIn Ads creative.
|
|
6
|
+
|
|
7
|
+
Returns preview rendering data for a creative URN.
|
|
8
|
+
|
|
9
|
+
**adFormat values:** SINGLE_IMAGE_AD, VIDEO_AD, CAROUSEL_AD, TEXT_AD,
|
|
10
|
+
SPOTLIGHT_AD, FOLLOWER_AD, MESSAGE_AD, CONVERSATION_AD`;
|
|
11
|
+
export const GetAdPreviewsInputSchema = z
|
|
12
|
+
.object({
|
|
13
|
+
creativeUrn: z
|
|
14
|
+
.string()
|
|
15
|
+
.min(1)
|
|
16
|
+
.describe("The creative URN to preview (e.g., urn:li:sponsoredCreative:123)"),
|
|
17
|
+
adFormat: z
|
|
18
|
+
.string()
|
|
19
|
+
.optional()
|
|
20
|
+
.describe("Ad format for the preview (e.g., SINGLE_IMAGE_AD)"),
|
|
21
|
+
})
|
|
22
|
+
.describe("Parameters for getting a LinkedIn ad preview");
|
|
23
|
+
export const GetAdPreviewsOutputSchema = z
|
|
24
|
+
.object({
|
|
25
|
+
preview: z.record(z.any()).describe("Preview data from LinkedIn API"),
|
|
26
|
+
creativeUrn: z.string(),
|
|
27
|
+
timestamp: z.string().datetime(),
|
|
28
|
+
})
|
|
29
|
+
.describe("Ad preview result");
|
|
30
|
+
export async function getAdPreviewsLogic(input, context, sdkContext) {
|
|
31
|
+
const { linkedInService } = resolveSessionServices(sdkContext);
|
|
32
|
+
const preview = await linkedInService.getAdPreviews(input.creativeUrn, input.adFormat, context);
|
|
33
|
+
return {
|
|
34
|
+
preview: preview,
|
|
35
|
+
creativeUrn: input.creativeUrn,
|
|
36
|
+
timestamp: new Date().toISOString(),
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
export function getAdPreviewsResponseFormatter(result) {
|
|
40
|
+
return [
|
|
41
|
+
{
|
|
42
|
+
type: "text",
|
|
43
|
+
text: `Ad preview for ${result.creativeUrn}\n\n${JSON.stringify(result.preview, null, 2)}\n\nTimestamp: ${result.timestamp}`,
|
|
44
|
+
},
|
|
45
|
+
];
|
|
46
|
+
}
|
|
47
|
+
export const getAdPreviewsTool = {
|
|
48
|
+
name: TOOL_NAME,
|
|
49
|
+
title: TOOL_TITLE,
|
|
50
|
+
description: TOOL_DESCRIPTION,
|
|
51
|
+
inputSchema: GetAdPreviewsInputSchema,
|
|
52
|
+
outputSchema: GetAdPreviewsOutputSchema,
|
|
53
|
+
annotations: {
|
|
54
|
+
readOnlyHint: true,
|
|
55
|
+
openWorldHint: false,
|
|
56
|
+
idempotentHint: true,
|
|
57
|
+
destructiveHint: false,
|
|
58
|
+
},
|
|
59
|
+
inputExamples: [
|
|
60
|
+
{
|
|
61
|
+
label: "Get preview for a creative",
|
|
62
|
+
input: {
|
|
63
|
+
creativeUrn: "urn:li:sponsoredCreative:123456789",
|
|
64
|
+
adFormat: "SINGLE_IMAGE_AD",
|
|
65
|
+
},
|
|
66
|
+
},
|
|
67
|
+
],
|
|
68
|
+
logic: getAdPreviewsLogic,
|
|
69
|
+
responseFormatter: getAdPreviewsResponseFormatter,
|
|
70
|
+
};
|
|
71
|
+
//# sourceMappingURL=get-ad-previews.tool.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-ad-previews.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-ad-previews.tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAIrE,MAAM,SAAS,GAAG,0BAA0B,CAAC;AAC7C,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,gBAAgB,GAAG;;;;;uDAK8B,CAAC;AAExD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,kEAAkE,CAAC;IAC/E,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,mDAAmD,CAAC;CACjE,CAAC;KACD,QAAQ,CAAC,8CAA8C,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,gCAAgC,CAAC;IACrE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAKjC,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAyB,EACzB,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,eAAe,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAE/D,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,aAAa,CACjD,KAAK,CAAC,WAAW,EACjB,KAAK,CAAC,QAAQ,EACd,OAAO,CACR,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,OAAkC;QAC3C,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,MAA2B;IACxE,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,kBAAkB,MAAM,CAAC,WAAW,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,MAAM,CAAC,SAAS,EAAE;SAC7H;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,wBAAwB;IACrC,YAAY,EAAE,yBAAyB;IACvC,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,KAAK;KACvB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,4BAA4B;YACnC,KAAK,EAAE;gBACL,WAAW,EAAE,oCAAoC;gBACjD,QAAQ,EAAE,iBAAiB;aAC5B;SACF;KACF;IACD,KAAK,EAAE,kBAAkB;IACzB,iBAAiB,EAAE,8BAA8B;CAClD,CAAC"}
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import type { RequestContext, McpTextContent } from "@cesteral/shared";
|
|
3
|
+
import type { SdkContext } from "@cesteral/shared";
|
|
4
|
+
export declare const GetAnalyticsBreakdownsInputSchema: z.ZodEffects<z.ZodObject<{
|
|
5
|
+
adAccountUrn: z.ZodString;
|
|
6
|
+
datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
|
|
7
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
8
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
9
|
+
pivots: z.ZodArray<z.ZodString, "many">;
|
|
10
|
+
metrics: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
11
|
+
} & {
|
|
12
|
+
includeComputedMetrics: z.ZodDefault<z.ZodBoolean>;
|
|
13
|
+
}, "strip", z.ZodTypeAny, {
|
|
14
|
+
adAccountUrn: string;
|
|
15
|
+
includeComputedMetrics: boolean;
|
|
16
|
+
pivots: string[];
|
|
17
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
18
|
+
startDate?: string | undefined;
|
|
19
|
+
endDate?: string | undefined;
|
|
20
|
+
metrics?: string[] | undefined;
|
|
21
|
+
}, {
|
|
22
|
+
adAccountUrn: string;
|
|
23
|
+
pivots: string[];
|
|
24
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
25
|
+
startDate?: string | undefined;
|
|
26
|
+
endDate?: string | undefined;
|
|
27
|
+
metrics?: string[] | undefined;
|
|
28
|
+
includeComputedMetrics?: boolean | undefined;
|
|
29
|
+
}>, {
|
|
30
|
+
adAccountUrn: string;
|
|
31
|
+
includeComputedMetrics: boolean;
|
|
32
|
+
pivots: string[];
|
|
33
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
34
|
+
startDate?: string | undefined;
|
|
35
|
+
endDate?: string | undefined;
|
|
36
|
+
metrics?: string[] | undefined;
|
|
37
|
+
}, {
|
|
38
|
+
adAccountUrn: string;
|
|
39
|
+
pivots: string[];
|
|
40
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
41
|
+
startDate?: string | undefined;
|
|
42
|
+
endDate?: string | undefined;
|
|
43
|
+
metrics?: string[] | undefined;
|
|
44
|
+
includeComputedMetrics?: boolean | undefined;
|
|
45
|
+
}>;
|
|
46
|
+
export declare const GetAnalyticsBreakdownsOutputSchema: z.ZodObject<{
|
|
47
|
+
results: z.ZodArray<z.ZodObject<{
|
|
48
|
+
pivot: z.ZodString;
|
|
49
|
+
elements: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">;
|
|
50
|
+
count: z.ZodNumber;
|
|
51
|
+
}, "strip", z.ZodTypeAny, {
|
|
52
|
+
count: number;
|
|
53
|
+
pivot: string;
|
|
54
|
+
elements: Record<string, any>[];
|
|
55
|
+
}, {
|
|
56
|
+
count: number;
|
|
57
|
+
pivot: string;
|
|
58
|
+
elements: Record<string, any>[];
|
|
59
|
+
}>, "many">;
|
|
60
|
+
dateRange: z.ZodObject<{
|
|
61
|
+
start: z.ZodString;
|
|
62
|
+
end: z.ZodString;
|
|
63
|
+
}, "strip", z.ZodTypeAny, {
|
|
64
|
+
start: string;
|
|
65
|
+
end: string;
|
|
66
|
+
}, {
|
|
67
|
+
start: string;
|
|
68
|
+
end: string;
|
|
69
|
+
}>;
|
|
70
|
+
timestamp: z.ZodString;
|
|
71
|
+
}, "strip", z.ZodTypeAny, {
|
|
72
|
+
results: {
|
|
73
|
+
count: number;
|
|
74
|
+
pivot: string;
|
|
75
|
+
elements: Record<string, any>[];
|
|
76
|
+
}[];
|
|
77
|
+
timestamp: string;
|
|
78
|
+
dateRange: {
|
|
79
|
+
start: string;
|
|
80
|
+
end: string;
|
|
81
|
+
};
|
|
82
|
+
}, {
|
|
83
|
+
results: {
|
|
84
|
+
count: number;
|
|
85
|
+
pivot: string;
|
|
86
|
+
elements: Record<string, any>[];
|
|
87
|
+
}[];
|
|
88
|
+
timestamp: string;
|
|
89
|
+
dateRange: {
|
|
90
|
+
start: string;
|
|
91
|
+
end: string;
|
|
92
|
+
};
|
|
93
|
+
}>;
|
|
94
|
+
type GetAnalyticsBreakdownsInput = z.infer<typeof GetAnalyticsBreakdownsInputSchema>;
|
|
95
|
+
type GetAnalyticsBreakdownsOutput = z.infer<typeof GetAnalyticsBreakdownsOutputSchema>;
|
|
96
|
+
export declare function getAnalyticsBreakdownsLogic(input: GetAnalyticsBreakdownsInput, context: RequestContext, sdkContext?: SdkContext): Promise<GetAnalyticsBreakdownsOutput>;
|
|
97
|
+
export declare function getAnalyticsBreakdownsResponseFormatter(result: GetAnalyticsBreakdownsOutput): McpTextContent[];
|
|
98
|
+
export declare const getAnalyticsBreakdownsTool: {
|
|
99
|
+
name: string;
|
|
100
|
+
title: string;
|
|
101
|
+
description: string;
|
|
102
|
+
inputSchema: z.ZodEffects<z.ZodObject<{
|
|
103
|
+
adAccountUrn: z.ZodString;
|
|
104
|
+
datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
|
|
105
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
106
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
107
|
+
pivots: z.ZodArray<z.ZodString, "many">;
|
|
108
|
+
metrics: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
109
|
+
} & {
|
|
110
|
+
includeComputedMetrics: z.ZodDefault<z.ZodBoolean>;
|
|
111
|
+
}, "strip", z.ZodTypeAny, {
|
|
112
|
+
adAccountUrn: string;
|
|
113
|
+
includeComputedMetrics: boolean;
|
|
114
|
+
pivots: string[];
|
|
115
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
116
|
+
startDate?: string | undefined;
|
|
117
|
+
endDate?: string | undefined;
|
|
118
|
+
metrics?: string[] | undefined;
|
|
119
|
+
}, {
|
|
120
|
+
adAccountUrn: string;
|
|
121
|
+
pivots: string[];
|
|
122
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
123
|
+
startDate?: string | undefined;
|
|
124
|
+
endDate?: string | undefined;
|
|
125
|
+
metrics?: string[] | undefined;
|
|
126
|
+
includeComputedMetrics?: boolean | undefined;
|
|
127
|
+
}>, {
|
|
128
|
+
adAccountUrn: string;
|
|
129
|
+
includeComputedMetrics: boolean;
|
|
130
|
+
pivots: string[];
|
|
131
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
132
|
+
startDate?: string | undefined;
|
|
133
|
+
endDate?: string | undefined;
|
|
134
|
+
metrics?: string[] | undefined;
|
|
135
|
+
}, {
|
|
136
|
+
adAccountUrn: string;
|
|
137
|
+
pivots: string[];
|
|
138
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
139
|
+
startDate?: string | undefined;
|
|
140
|
+
endDate?: string | undefined;
|
|
141
|
+
metrics?: string[] | undefined;
|
|
142
|
+
includeComputedMetrics?: boolean | undefined;
|
|
143
|
+
}>;
|
|
144
|
+
outputSchema: z.ZodObject<{
|
|
145
|
+
results: z.ZodArray<z.ZodObject<{
|
|
146
|
+
pivot: z.ZodString;
|
|
147
|
+
elements: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">;
|
|
148
|
+
count: z.ZodNumber;
|
|
149
|
+
}, "strip", z.ZodTypeAny, {
|
|
150
|
+
count: number;
|
|
151
|
+
pivot: string;
|
|
152
|
+
elements: Record<string, any>[];
|
|
153
|
+
}, {
|
|
154
|
+
count: number;
|
|
155
|
+
pivot: string;
|
|
156
|
+
elements: Record<string, any>[];
|
|
157
|
+
}>, "many">;
|
|
158
|
+
dateRange: z.ZodObject<{
|
|
159
|
+
start: z.ZodString;
|
|
160
|
+
end: z.ZodString;
|
|
161
|
+
}, "strip", z.ZodTypeAny, {
|
|
162
|
+
start: string;
|
|
163
|
+
end: string;
|
|
164
|
+
}, {
|
|
165
|
+
start: string;
|
|
166
|
+
end: string;
|
|
167
|
+
}>;
|
|
168
|
+
timestamp: z.ZodString;
|
|
169
|
+
}, "strip", z.ZodTypeAny, {
|
|
170
|
+
results: {
|
|
171
|
+
count: number;
|
|
172
|
+
pivot: string;
|
|
173
|
+
elements: Record<string, any>[];
|
|
174
|
+
}[];
|
|
175
|
+
timestamp: string;
|
|
176
|
+
dateRange: {
|
|
177
|
+
start: string;
|
|
178
|
+
end: string;
|
|
179
|
+
};
|
|
180
|
+
}, {
|
|
181
|
+
results: {
|
|
182
|
+
count: number;
|
|
183
|
+
pivot: string;
|
|
184
|
+
elements: Record<string, any>[];
|
|
185
|
+
}[];
|
|
186
|
+
timestamp: string;
|
|
187
|
+
dateRange: {
|
|
188
|
+
start: string;
|
|
189
|
+
end: string;
|
|
190
|
+
};
|
|
191
|
+
}>;
|
|
192
|
+
annotations: {
|
|
193
|
+
readOnlyHint: boolean;
|
|
194
|
+
openWorldHint: boolean;
|
|
195
|
+
idempotentHint: boolean;
|
|
196
|
+
destructiveHint: boolean;
|
|
197
|
+
};
|
|
198
|
+
inputExamples: ({
|
|
199
|
+
label: string;
|
|
200
|
+
input: {
|
|
201
|
+
adAccountUrn: string;
|
|
202
|
+
datePreset: string;
|
|
203
|
+
pivots: string[];
|
|
204
|
+
metrics: string[];
|
|
205
|
+
startDate?: undefined;
|
|
206
|
+
endDate?: undefined;
|
|
207
|
+
};
|
|
208
|
+
} | {
|
|
209
|
+
label: string;
|
|
210
|
+
input: {
|
|
211
|
+
adAccountUrn: string;
|
|
212
|
+
startDate: string;
|
|
213
|
+
endDate: string;
|
|
214
|
+
pivots: string[];
|
|
215
|
+
datePreset?: undefined;
|
|
216
|
+
metrics?: undefined;
|
|
217
|
+
};
|
|
218
|
+
})[];
|
|
219
|
+
logic: typeof getAnalyticsBreakdownsLogic;
|
|
220
|
+
responseFormatter: typeof getAnalyticsBreakdownsResponseFormatter;
|
|
221
|
+
};
|
|
222
|
+
export {};
|
|
223
|
+
//# sourceMappingURL=get-analytics-breakdowns.tool.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-analytics-breakdowns.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-analytics-breakdowns.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAanD,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmC8B,CAAC;AAE7E,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcL,CAAC;AAE3C,KAAK,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AACrF,KAAK,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAEvF,wBAAsB,2BAA2B,CAC/C,KAAK,EAAE,2BAA2B,EAClC,OAAO,EAAE,cAAc,EACvB,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,4BAA4B,CAAC,CA0CvC;AAUD,wBAAgB,uCAAuC,CACrD,MAAM,EAAE,4BAA4B,GACnC,cAAc,EAAE,CAoBlB;AAED,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCtC,CAAC"}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { resolveSessionServices } from "../utils/resolve-session.js";
|
|
3
|
+
import { appendComputedMetricsToRows, ComputedMetricsFlagSchema, DATE_PRESET_VALUES, resolveDatePreset, } from "@cesteral/shared";
|
|
4
|
+
const TOOL_NAME = "linkedin_get_analytics_breakdowns";
|
|
5
|
+
const TOOL_TITLE = "Get LinkedIn Ads Analytics with Breakdowns";
|
|
6
|
+
const TOOL_DESCRIPTION = `Get analytics with multiple dimensional breakdowns for a LinkedIn Ads account.
|
|
7
|
+
|
|
8
|
+
Runs one analytics query per pivot and returns combined results.
|
|
9
|
+
|
|
10
|
+
**Useful pivot combinations:**
|
|
11
|
+
- CAMPAIGN + MEMBER_COUNTRY: campaign performance by geography
|
|
12
|
+
- CAMPAIGN + MEMBER_JOB_TITLE: audience composition
|
|
13
|
+
- CREATIVE + CAMPAIGN: creative performance within campaigns`;
|
|
14
|
+
export const GetAnalyticsBreakdownsInputSchema = z
|
|
15
|
+
.object({
|
|
16
|
+
adAccountUrn: z
|
|
17
|
+
.string()
|
|
18
|
+
.min(1)
|
|
19
|
+
.describe("The ad account URN (e.g., urn:li:sponsoredAccount:123)"),
|
|
20
|
+
datePreset: z
|
|
21
|
+
.enum(DATE_PRESET_VALUES)
|
|
22
|
+
.optional()
|
|
23
|
+
.describe("Preset date range. Use this OR startDate+endDate (not both)"),
|
|
24
|
+
startDate: z
|
|
25
|
+
.string()
|
|
26
|
+
.regex(/^\d{4}-\d{2}-\d{2}$/, "Date must be in YYYY-MM-DD format")
|
|
27
|
+
.optional()
|
|
28
|
+
.describe("Start date in YYYY-MM-DD format (required if datePreset not provided)"),
|
|
29
|
+
endDate: z
|
|
30
|
+
.string()
|
|
31
|
+
.regex(/^\d{4}-\d{2}-\d{2}$/, "Date must be in YYYY-MM-DD format")
|
|
32
|
+
.optional()
|
|
33
|
+
.describe("End date in YYYY-MM-DD format (required if datePreset not provided)"),
|
|
34
|
+
pivots: z
|
|
35
|
+
.array(z.string())
|
|
36
|
+
.min(1)
|
|
37
|
+
.describe("Pivot dimensions to break down by (e.g., CAMPAIGN, MEMBER_COUNTRY)"),
|
|
38
|
+
metrics: z
|
|
39
|
+
.array(z.string())
|
|
40
|
+
.optional()
|
|
41
|
+
.describe("Metrics to retrieve (defaults to impressions, clicks, costInUsd)"),
|
|
42
|
+
})
|
|
43
|
+
.merge(ComputedMetricsFlagSchema)
|
|
44
|
+
.refine((data) => data.datePreset !== undefined || (data.startDate !== undefined && data.endDate !== undefined), { message: "Provide either datePreset or both startDate and endDate" })
|
|
45
|
+
.describe("Parameters for getting LinkedIn Ads analytics with breakdowns");
|
|
46
|
+
export const GetAnalyticsBreakdownsOutputSchema = z
|
|
47
|
+
.object({
|
|
48
|
+
results: z
|
|
49
|
+
.array(z.object({
|
|
50
|
+
pivot: z.string(),
|
|
51
|
+
elements: z.array(z.record(z.any())),
|
|
52
|
+
count: z.number(),
|
|
53
|
+
}))
|
|
54
|
+
.describe("Analytics results per pivot"),
|
|
55
|
+
dateRange: z.object({ start: z.string(), end: z.string() }),
|
|
56
|
+
timestamp: z.string().datetime(),
|
|
57
|
+
})
|
|
58
|
+
.describe("Analytics breakdowns result");
|
|
59
|
+
export async function getAnalyticsBreakdownsLogic(input, context, sdkContext) {
|
|
60
|
+
const { linkedInReportingService } = resolveSessionServices(sdkContext);
|
|
61
|
+
let resolvedStartDate = input.startDate;
|
|
62
|
+
let resolvedEndDate = input.endDate;
|
|
63
|
+
if (input.datePreset) {
|
|
64
|
+
const resolved = resolveDatePreset(input.datePreset);
|
|
65
|
+
resolvedStartDate = resolved.startDate;
|
|
66
|
+
resolvedEndDate = resolved.endDate;
|
|
67
|
+
}
|
|
68
|
+
const result = await linkedInReportingService.getAnalyticsBreakdowns(input.adAccountUrn, { start: resolvedStartDate, end: resolvedEndDate }, input.pivots, input.metrics, undefined, context);
|
|
69
|
+
return {
|
|
70
|
+
results: result.results.map((r) => {
|
|
71
|
+
const raw = r.elements;
|
|
72
|
+
const stringRows = raw.map((row) => {
|
|
73
|
+
const record = {};
|
|
74
|
+
for (const [k, v] of Object.entries(row)) {
|
|
75
|
+
record[k] = typeof v === "string" ? v : v == null ? "" : JSON.stringify(v);
|
|
76
|
+
}
|
|
77
|
+
return record;
|
|
78
|
+
});
|
|
79
|
+
const elements = input.includeComputedMetrics
|
|
80
|
+
? appendComputedMetricsToRows(stringRows, BREAKDOWNS_COMPUTED_METRIC_ALIASES)
|
|
81
|
+
: stringRows;
|
|
82
|
+
return {
|
|
83
|
+
pivot: r.pivot,
|
|
84
|
+
elements: elements,
|
|
85
|
+
count: elements.length,
|
|
86
|
+
};
|
|
87
|
+
}),
|
|
88
|
+
dateRange: { start: resolvedStartDate, end: resolvedEndDate },
|
|
89
|
+
timestamp: new Date().toISOString(),
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
const BREAKDOWNS_COMPUTED_METRIC_ALIASES = {
|
|
93
|
+
cost: ["costInUsd", "costInLocalCurrency"],
|
|
94
|
+
impressions: ["impressions"],
|
|
95
|
+
clicks: ["clicks"],
|
|
96
|
+
conversions: ["externalWebsiteConversions", "conversions", "oneClickLeads"],
|
|
97
|
+
conversionValue: ["conversionValueInLocalCurrency"],
|
|
98
|
+
};
|
|
99
|
+
export function getAnalyticsBreakdownsResponseFormatter(result) {
|
|
100
|
+
const lines = [
|
|
101
|
+
`Analytics Breakdowns — Date range: ${result.dateRange.start} to ${result.dateRange.end}`,
|
|
102
|
+
"",
|
|
103
|
+
];
|
|
104
|
+
for (const r of result.results) {
|
|
105
|
+
lines.push(`## ${r.pivot} (${r.count} rows)`);
|
|
106
|
+
lines.push(JSON.stringify(r.elements, null, 2));
|
|
107
|
+
lines.push("");
|
|
108
|
+
}
|
|
109
|
+
lines.push(`Timestamp: ${result.timestamp}`);
|
|
110
|
+
return [
|
|
111
|
+
{
|
|
112
|
+
type: "text",
|
|
113
|
+
text: lines.join("\n"),
|
|
114
|
+
},
|
|
115
|
+
];
|
|
116
|
+
}
|
|
117
|
+
export const getAnalyticsBreakdownsTool = {
|
|
118
|
+
name: TOOL_NAME,
|
|
119
|
+
title: TOOL_TITLE,
|
|
120
|
+
description: TOOL_DESCRIPTION,
|
|
121
|
+
inputSchema: GetAnalyticsBreakdownsInputSchema,
|
|
122
|
+
outputSchema: GetAnalyticsBreakdownsOutputSchema,
|
|
123
|
+
annotations: {
|
|
124
|
+
readOnlyHint: true,
|
|
125
|
+
openWorldHint: false,
|
|
126
|
+
idempotentHint: true,
|
|
127
|
+
destructiveHint: false,
|
|
128
|
+
},
|
|
129
|
+
inputExamples: [
|
|
130
|
+
{
|
|
131
|
+
label: "Get campaign + country breakdown for last 30 days",
|
|
132
|
+
input: {
|
|
133
|
+
adAccountUrn: "urn:li:sponsoredAccount:123456789",
|
|
134
|
+
datePreset: "LAST_30_DAYS",
|
|
135
|
+
pivots: ["CAMPAIGN", "MEMBER_COUNTRY"],
|
|
136
|
+
metrics: ["impressions", "clicks", "costInUsd"],
|
|
137
|
+
},
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
label: "Get creative performance breakdown",
|
|
141
|
+
input: {
|
|
142
|
+
adAccountUrn: "urn:li:sponsoredAccount:123456789",
|
|
143
|
+
startDate: "2026-01-01",
|
|
144
|
+
endDate: "2026-03-01",
|
|
145
|
+
pivots: ["CREATIVE"],
|
|
146
|
+
},
|
|
147
|
+
},
|
|
148
|
+
],
|
|
149
|
+
logic: getAnalyticsBreakdownsLogic,
|
|
150
|
+
responseFormatter: getAnalyticsBreakdownsResponseFormatter,
|
|
151
|
+
};
|
|
152
|
+
//# sourceMappingURL=get-analytics-breakdowns.tool.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-analytics-breakdowns.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-analytics-breakdowns.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAI1B,MAAM,SAAS,GAAG,mCAAmC,CAAC;AACtD,MAAM,UAAU,GAAG,4CAA4C,CAAC;AAChE,MAAM,gBAAgB,GAAG;;;;;;;6DAOoC,CAAC;AAE9D,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC;KAC/C,MAAM,CAAC;IACN,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,wDAAwD,CAAC;IACrE,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,kBAAkB,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,KAAK,CAAC,qBAAqB,EAAE,mCAAmC,CAAC;SACjE,QAAQ,EAAE;SACV,QAAQ,CAAC,uEAAuE,CAAC;IACpF,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,KAAK,CAAC,qBAAqB,EAAE,mCAAmC,CAAC;SACjE,QAAQ,EAAE;SACV,QAAQ,CAAC,qEAAqE,CAAC;IAClF,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,oEAAoE,CAAC;IACjF,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,kEAAkE,CAAC;CAChF,CAAC;KACD,KAAK,CAAC,yBAAyB,CAAC;KAChC,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,EAC/F,EAAE,OAAO,EAAE,yDAAyD,EAAE,CACvE;KACA,QAAQ,CAAC,+DAA+D,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC;KAChD,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;KAClB,CAAC,CACH;SACA,QAAQ,CAAC,6BAA6B,CAAC;IAC1C,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IAC3D,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,6BAA6B,CAAC,CAAC;AAK3C,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,KAAkC,EAClC,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,wBAAwB,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAExE,IAAI,iBAAiB,GAAG,KAAK,CAAC,SAAS,CAAC;IACxC,IAAI,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC;IACpC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,iBAAiB,GAAG,QAAQ,CAAC,SAAS,CAAC;QACvC,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC;IACrC,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC,sBAAsB,CAClE,KAAK,CAAC,YAAY,EAClB,EAAE,KAAK,EAAE,iBAAkB,EAAE,GAAG,EAAE,eAAgB,EAAE,EACpD,KAAK,CAAC,MAAM,EACZ,KAAK,CAAC,OAAO,EACb,SAAS,EACT,OAAO,CACR,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAChC,MAAM,GAAG,GAAG,CAAC,CAAC,QAAqC,CAAC;YACpD,MAAM,UAAU,GAA6B,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3D,MAAM,MAAM,GAA2B,EAAE,CAAC;gBAC1C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzC,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC7E,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,KAAK,CAAC,sBAAsB;gBAC3C,CAAC,CAAC,2BAA2B,CAAC,UAAU,EAAE,kCAAkC,CAAC;gBAC7E,CAAC,CAAC,UAAU,CAAC;YACf,OAAO;gBACL,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,QAAQ,EAAE,QAAqC;gBAC/C,KAAK,EAAE,QAAQ,CAAC,MAAM;aACvB,CAAC;QACJ,CAAC,CAAC;QACF,SAAS,EAAE,EAAE,KAAK,EAAE,iBAAkB,EAAE,GAAG,EAAE,eAAgB,EAAE;QAC/D,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,kCAAkC,GAAG;IACzC,IAAI,EAAE,CAAC,WAAW,EAAE,qBAAqB,CAAC;IAC1C,WAAW,EAAE,CAAC,aAAa,CAAC;IAC5B,MAAM,EAAE,CAAC,QAAQ,CAAC;IAClB,WAAW,EAAE,CAAC,4BAA4B,EAAE,aAAa,EAAE,eAAe,CAAC;IAC3E,eAAe,EAAE,CAAC,gCAAgC,CAAC;CACpD,CAAC;AAEF,MAAM,UAAU,uCAAuC,CACrD,MAAoC;IAEpC,MAAM,KAAK,GAAa;QACtB,sCAAsC,MAAM,CAAC,SAAS,CAAC,KAAK,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE;QACzF,EAAE;KACH,CAAC;IAEF,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7C,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;SACvB;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,iCAAiC;IAC9C,YAAY,EAAE,kCAAkC;IAChD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,KAAK;KACvB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,mDAAmD;YAC1D,KAAK,EAAE;gBACL,YAAY,EAAE,mCAAmC;gBACjD,UAAU,EAAE,cAAc;gBAC1B,MAAM,EAAE,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBACtC,OAAO,EAAE,CAAC,aAAa,EAAE,QAAQ,EAAE,WAAW,CAAC;aAChD;SACF;QACD;YACE,KAAK,EAAE,oCAAoC;YAC3C,KAAK,EAAE;gBACL,YAAY,EAAE,mCAAmC;gBACjD,SAAS,EAAE,YAAY;gBACvB,OAAO,EAAE,YAAY;gBACrB,MAAM,EAAE,CAAC,UAAU,CAAC;aACrB;SACF;KACF;IACD,KAAK,EAAE,2BAA2B;IAClC,iBAAiB,EAAE,uCAAuC;CAC3D,CAAC"}
|