@cesteral/msads-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.
Files changed (255) hide show
  1. package/LICENSE.md +201 -0
  2. package/README.md +179 -0
  3. package/dist/auth/index.d.ts +3 -0
  4. package/dist/auth/index.d.ts.map +1 -0
  5. package/dist/auth/index.js +3 -0
  6. package/dist/auth/index.js.map +1 -0
  7. package/dist/auth/msads-auth-adapter.d.ts +27 -0
  8. package/dist/auth/msads-auth-adapter.d.ts.map +1 -0
  9. package/dist/auth/msads-auth-adapter.js +79 -0
  10. package/dist/auth/msads-auth-adapter.js.map +1 -0
  11. package/dist/auth/msads-auth-strategy.d.ts +8 -0
  12. package/dist/auth/msads-auth-strategy.d.ts.map +1 -0
  13. package/dist/auth/msads-auth-strategy.js +36 -0
  14. package/dist/auth/msads-auth-strategy.js.map +1 -0
  15. package/dist/config/index.d.ts +112 -0
  16. package/dist/config/index.d.ts.map +1 -0
  17. package/dist/config/index.js +56 -0
  18. package/dist/config/index.js.map +1 -0
  19. package/dist/index.d.ts +3 -0
  20. package/dist/index.d.ts.map +1 -0
  21. package/dist/index.js +47 -0
  22. package/dist/index.js.map +1 -0
  23. package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.d.ts +4 -0
  24. package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.d.ts.map +1 -0
  25. package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.js +54 -0
  26. package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.js.map +1 -0
  27. package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.d.ts +4 -0
  28. package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.d.ts.map +1 -0
  29. package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.js +147 -0
  30. package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.js.map +1 -0
  31. package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.d.ts +4 -0
  32. package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.d.ts.map +1 -0
  33. package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.js +73 -0
  34. package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.js.map +1 -0
  35. package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.d.ts +4 -0
  36. package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.d.ts.map +1 -0
  37. package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.js +55 -0
  38. package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.js.map +1 -0
  39. package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.d.ts +4 -0
  40. package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.d.ts.map +1 -0
  41. package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.js +47 -0
  42. package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.js.map +1 -0
  43. package/dist/mcp-server/prompts/index.d.ts +9 -0
  44. package/dist/mcp-server/prompts/index.d.ts.map +1 -0
  45. package/dist/mcp-server/prompts/index.js +49 -0
  46. package/dist/mcp-server/prompts/index.js.map +1 -0
  47. package/dist/mcp-server/resources/definitions/entity-examples.resource.d.ts +4 -0
  48. package/dist/mcp-server/resources/definitions/entity-examples.resource.d.ts.map +1 -0
  49. package/dist/mcp-server/resources/definitions/entity-examples.resource.js +84 -0
  50. package/dist/mcp-server/resources/definitions/entity-examples.resource.js.map +1 -0
  51. package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.d.ts +3 -0
  52. package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.d.ts.map +1 -0
  53. package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.js +54 -0
  54. package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.js.map +1 -0
  55. package/dist/mcp-server/resources/definitions/entity-schemas.resource.d.ts +4 -0
  56. package/dist/mcp-server/resources/definitions/entity-schemas.resource.d.ts.map +1 -0
  57. package/dist/mcp-server/resources/definitions/entity-schemas.resource.js +54 -0
  58. package/dist/mcp-server/resources/definitions/entity-schemas.resource.js.map +1 -0
  59. package/dist/mcp-server/resources/definitions/field-rules.resource.d.ts +3 -0
  60. package/dist/mcp-server/resources/definitions/field-rules.resource.d.ts.map +1 -0
  61. package/dist/mcp-server/resources/definitions/field-rules.resource.js +28 -0
  62. package/dist/mcp-server/resources/definitions/field-rules.resource.js.map +1 -0
  63. package/dist/mcp-server/resources/definitions/index.d.ts +7 -0
  64. package/dist/mcp-server/resources/definitions/index.d.ts.map +1 -0
  65. package/dist/mcp-server/resources/definitions/index.js +79 -0
  66. package/dist/mcp-server/resources/definitions/index.js.map +1 -0
  67. package/dist/mcp-server/resources/definitions/reporting-reference.resource.d.ts +3 -0
  68. package/dist/mcp-server/resources/definitions/reporting-reference.resource.d.ts.map +1 -0
  69. package/dist/mcp-server/resources/definitions/reporting-reference.resource.js +64 -0
  70. package/dist/mcp-server/resources/definitions/reporting-reference.resource.js.map +1 -0
  71. package/dist/mcp-server/resources/index.d.ts +3 -0
  72. package/dist/mcp-server/resources/index.d.ts.map +1 -0
  73. package/dist/mcp-server/resources/index.js +2 -0
  74. package/dist/mcp-server/resources/index.js.map +1 -0
  75. package/dist/mcp-server/resources/types.d.ts +8 -0
  76. package/dist/mcp-server/resources/types.d.ts.map +1 -0
  77. package/dist/mcp-server/resources/types.js +2 -0
  78. package/dist/mcp-server/resources/types.js.map +1 -0
  79. package/dist/mcp-server/resources/utils/field-rules.d.ts +9 -0
  80. package/dist/mcp-server/resources/utils/field-rules.d.ts.map +1 -0
  81. package/dist/mcp-server/resources/utils/field-rules.js +106 -0
  82. package/dist/mcp-server/resources/utils/field-rules.js.map +1 -0
  83. package/dist/mcp-server/server.d.ts +5 -0
  84. package/dist/mcp-server/server.d.ts.map +1 -0
  85. package/dist/mcp-server/server.js +142 -0
  86. package/dist/mcp-server/server.js.map +1 -0
  87. package/dist/mcp-server/tools/definitions/adjust-bids.tool.d.ts +175 -0
  88. package/dist/mcp-server/tools/definitions/adjust-bids.tool.d.ts.map +1 -0
  89. package/dist/mcp-server/tools/definitions/adjust-bids.tool.js +124 -0
  90. package/dist/mcp-server/tools/definitions/adjust-bids.tool.js.map +1 -0
  91. package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.d.ts +83 -0
  92. package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.d.ts.map +1 -0
  93. package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.js +68 -0
  94. package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.js.map +1 -0
  95. package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.d.ts +95 -0
  96. package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.d.ts.map +1 -0
  97. package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.js +102 -0
  98. package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.js.map +1 -0
  99. package/dist/mcp-server/tools/definitions/bulk-update-status.tool.d.ts +151 -0
  100. package/dist/mcp-server/tools/definitions/bulk-update-status.tool.d.ts.map +1 -0
  101. package/dist/mcp-server/tools/definitions/bulk-update-status.tool.js +112 -0
  102. package/dist/mcp-server/tools/definitions/bulk-update-status.tool.js.map +1 -0
  103. package/dist/mcp-server/tools/definitions/check-report-status.tool.d.ts +111 -0
  104. package/dist/mcp-server/tools/definitions/check-report-status.tool.d.ts.map +1 -0
  105. package/dist/mcp-server/tools/definitions/check-report-status.tool.js +73 -0
  106. package/dist/mcp-server/tools/definitions/check-report-status.tool.js.map +1 -0
  107. package/dist/mcp-server/tools/definitions/create-entity.tool.d.ts +81 -0
  108. package/dist/mcp-server/tools/definitions/create-entity.tool.d.ts.map +1 -0
  109. package/dist/mcp-server/tools/definitions/create-entity.tool.js +74 -0
  110. package/dist/mcp-server/tools/definitions/create-entity.tool.js.map +1 -0
  111. package/dist/mcp-server/tools/definitions/create-report-schedule.tool.d.ts +160 -0
  112. package/dist/mcp-server/tools/definitions/create-report-schedule.tool.d.ts.map +1 -0
  113. package/dist/mcp-server/tools/definitions/create-report-schedule.tool.js +108 -0
  114. package/dist/mcp-server/tools/definitions/create-report-schedule.tool.js.map +1 -0
  115. package/dist/mcp-server/tools/definitions/delete-entity.tool.d.ts +98 -0
  116. package/dist/mcp-server/tools/definitions/delete-entity.tool.d.ts.map +1 -0
  117. package/dist/mcp-server/tools/definitions/delete-entity.tool.js +94 -0
  118. package/dist/mcp-server/tools/definitions/delete-entity.tool.js.map +1 -0
  119. package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.d.ts +79 -0
  120. package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.d.ts.map +1 -0
  121. package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.js +88 -0
  122. package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.js.map +1 -0
  123. package/dist/mcp-server/tools/definitions/download-report.tool.d.ts +287 -0
  124. package/dist/mcp-server/tools/definitions/download-report.tool.d.ts.map +1 -0
  125. package/dist/mcp-server/tools/definitions/download-report.tool.js +85 -0
  126. package/dist/mcp-server/tools/definitions/download-report.tool.js.map +1 -0
  127. package/dist/mcp-server/tools/definitions/get-ad-details.tool.d.ts +68 -0
  128. package/dist/mcp-server/tools/definitions/get-ad-details.tool.d.ts.map +1 -0
  129. package/dist/mcp-server/tools/definitions/get-ad-details.tool.js +85 -0
  130. package/dist/mcp-server/tools/definitions/get-ad-details.tool.js.map +1 -0
  131. package/dist/mcp-server/tools/definitions/get-ad-preview.tool.d.ts +68 -0
  132. package/dist/mcp-server/tools/definitions/get-ad-preview.tool.d.ts.map +1 -0
  133. package/dist/mcp-server/tools/definitions/get-ad-preview.tool.js +90 -0
  134. package/dist/mcp-server/tools/definitions/get-ad-preview.tool.js.map +1 -0
  135. package/dist/mcp-server/tools/definitions/get-entity.tool.d.ts +285 -0
  136. package/dist/mcp-server/tools/definitions/get-entity.tool.d.ts.map +1 -0
  137. package/dist/mcp-server/tools/definitions/get-entity.tool.js +120 -0
  138. package/dist/mcp-server/tools/definitions/get-entity.tool.js.map +1 -0
  139. package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts +280 -0
  140. package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts.map +1 -0
  141. package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js +138 -0
  142. package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js.map +1 -0
  143. package/dist/mcp-server/tools/definitions/get-report.tool.d.ts +260 -0
  144. package/dist/mcp-server/tools/definitions/get-report.tool.d.ts.map +1 -0
  145. package/dist/mcp-server/tools/definitions/get-report.tool.js +118 -0
  146. package/dist/mcp-server/tools/definitions/get-report.tool.js.map +1 -0
  147. package/dist/mcp-server/tools/definitions/import-from-google.tool.d.ts +79 -0
  148. package/dist/mcp-server/tools/definitions/import-from-google.tool.d.ts.map +1 -0
  149. package/dist/mcp-server/tools/definitions/import-from-google.tool.js +88 -0
  150. package/dist/mcp-server/tools/definitions/import-from-google.tool.js.map +1 -0
  151. package/dist/mcp-server/tools/definitions/index.d.ts +3 -0
  152. package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -0
  153. package/dist/mcp-server/tools/definitions/index.js +53 -0
  154. package/dist/mcp-server/tools/definitions/index.js.map +1 -0
  155. package/dist/mcp-server/tools/definitions/list-accounts.tool.d.ts +135 -0
  156. package/dist/mcp-server/tools/definitions/list-accounts.tool.d.ts.map +1 -0
  157. package/dist/mcp-server/tools/definitions/list-accounts.tool.js +88 -0
  158. package/dist/mcp-server/tools/definitions/list-accounts.tool.js.map +1 -0
  159. package/dist/mcp-server/tools/definitions/list-entities.tool.d.ts +120 -0
  160. package/dist/mcp-server/tools/definitions/list-entities.tool.d.ts.map +1 -0
  161. package/dist/mcp-server/tools/definitions/list-entities.tool.js +100 -0
  162. package/dist/mcp-server/tools/definitions/list-entities.tool.js.map +1 -0
  163. package/dist/mcp-server/tools/definitions/list-report-schedules.tool.d.ts +47 -0
  164. package/dist/mcp-server/tools/definitions/list-report-schedules.tool.d.ts.map +1 -0
  165. package/dist/mcp-server/tools/definitions/list-report-schedules.tool.js +57 -0
  166. package/dist/mcp-server/tools/definitions/list-report-schedules.tool.js.map +1 -0
  167. package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.d.ts +81 -0
  168. package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.d.ts.map +1 -0
  169. package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.js +81 -0
  170. package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.js.map +1 -0
  171. package/dist/mcp-server/tools/definitions/manage-criterions.tool.d.ts +90 -0
  172. package/dist/mcp-server/tools/definitions/manage-criterions.tool.d.ts.map +1 -0
  173. package/dist/mcp-server/tools/definitions/manage-criterions.tool.js +92 -0
  174. package/dist/mcp-server/tools/definitions/manage-criterions.tool.js.map +1 -0
  175. package/dist/mcp-server/tools/definitions/search-targeting.tool.d.ts +79 -0
  176. package/dist/mcp-server/tools/definitions/search-targeting.tool.d.ts.map +1 -0
  177. package/dist/mcp-server/tools/definitions/search-targeting.tool.js +105 -0
  178. package/dist/mcp-server/tools/definitions/search-targeting.tool.js.map +1 -0
  179. package/dist/mcp-server/tools/definitions/submit-report.tool.d.ts +132 -0
  180. package/dist/mcp-server/tools/definitions/submit-report.tool.d.ts.map +1 -0
  181. package/dist/mcp-server/tools/definitions/submit-report.tool.js +94 -0
  182. package/dist/mcp-server/tools/definitions/submit-report.tool.js.map +1 -0
  183. package/dist/mcp-server/tools/definitions/update-entity.tool.d.ts +79 -0
  184. package/dist/mcp-server/tools/definitions/update-entity.tool.d.ts.map +1 -0
  185. package/dist/mcp-server/tools/definitions/update-entity.tool.js +64 -0
  186. package/dist/mcp-server/tools/definitions/update-entity.tool.js.map +1 -0
  187. package/dist/mcp-server/tools/definitions/validate-entity.tool.d.ts +174 -0
  188. package/dist/mcp-server/tools/definitions/validate-entity.tool.d.ts.map +1 -0
  189. package/dist/mcp-server/tools/definitions/validate-entity.tool.js +142 -0
  190. package/dist/mcp-server/tools/definitions/validate-entity.tool.js.map +1 -0
  191. package/dist/mcp-server/tools/index.d.ts +2 -0
  192. package/dist/mcp-server/tools/index.d.ts.map +1 -0
  193. package/dist/mcp-server/tools/index.js +2 -0
  194. package/dist/mcp-server/tools/index.js.map +1 -0
  195. package/dist/mcp-server/tools/utils/entity-mapping.d.ts +20 -0
  196. package/dist/mcp-server/tools/utils/entity-mapping.d.ts.map +1 -0
  197. package/dist/mcp-server/tools/utils/entity-mapping.js +118 -0
  198. package/dist/mcp-server/tools/utils/entity-mapping.js.map +1 -0
  199. package/dist/mcp-server/tools/utils/resolve-session.d.ts +4 -0
  200. package/dist/mcp-server/tools/utils/resolve-session.d.ts.map +1 -0
  201. package/dist/mcp-server/tools/utils/resolve-session.js +6 -0
  202. package/dist/mcp-server/tools/utils/resolve-session.js.map +1 -0
  203. package/dist/mcp-server/transports/streamable-http-transport.d.ts +55 -0
  204. package/dist/mcp-server/transports/streamable-http-transport.d.ts.map +1 -0
  205. package/dist/mcp-server/transports/streamable-http-transport.js +86 -0
  206. package/dist/mcp-server/transports/streamable-http-transport.js.map +1 -0
  207. package/dist/services/msads/msads-http-client.d.ts +16 -0
  208. package/dist/services/msads/msads-http-client.d.ts.map +1 -0
  209. package/dist/services/msads/msads-http-client.js +89 -0
  210. package/dist/services/msads/msads-http-client.js.map +1 -0
  211. package/dist/services/msads/msads-reporting-service.d.ts +58 -0
  212. package/dist/services/msads/msads-reporting-service.d.ts.map +1 -0
  213. package/dist/services/msads/msads-reporting-service.js +153 -0
  214. package/dist/services/msads/msads-reporting-service.js.map +1 -0
  215. package/dist/services/msads/msads-service.d.ts +54 -0
  216. package/dist/services/msads/msads-service.d.ts.map +1 -0
  217. package/dist/services/msads/msads-service.js +179 -0
  218. package/dist/services/msads/msads-service.js.map +1 -0
  219. package/dist/services/msads/rate-limit-keys.d.ts +3 -0
  220. package/dist/services/msads/rate-limit-keys.d.ts.map +1 -0
  221. package/dist/services/msads/rate-limit-keys.js +3 -0
  222. package/dist/services/msads/rate-limit-keys.js.map +1 -0
  223. package/dist/services/msads/types.d.ts +196 -0
  224. package/dist/services/msads/types.d.ts.map +1 -0
  225. package/dist/services/msads/types.js +47 -0
  226. package/dist/services/msads/types.js.map +1 -0
  227. package/dist/services/session-services.d.ts +22 -0
  228. package/dist/services/session-services.d.ts.map +1 -0
  229. package/dist/services/session-services.js +22 -0
  230. package/dist/services/session-services.js.map +1 -0
  231. package/dist/types-global/mcp.d.ts +2 -0
  232. package/dist/types-global/mcp.d.ts.map +1 -0
  233. package/dist/types-global/mcp.js +2 -0
  234. package/dist/types-global/mcp.js.map +1 -0
  235. package/dist/utils/errors/index.d.ts +2 -0
  236. package/dist/utils/errors/index.d.ts.map +1 -0
  237. package/dist/utils/errors/index.js +2 -0
  238. package/dist/utils/errors/index.js.map +1 -0
  239. package/dist/utils/platform.d.ts +3 -0
  240. package/dist/utils/platform.d.ts.map +1 -0
  241. package/dist/utils/platform.js +5 -0
  242. package/dist/utils/platform.js.map +1 -0
  243. package/dist/utils/security/rate-limiter.d.ts +3 -0
  244. package/dist/utils/security/rate-limiter.d.ts.map +1 -0
  245. package/dist/utils/security/rate-limiter.js +5 -0
  246. package/dist/utils/security/rate-limiter.js.map +1 -0
  247. package/dist/utils/telemetry/index.d.ts +2 -0
  248. package/dist/utils/telemetry/index.d.ts.map +1 -0
  249. package/dist/utils/telemetry/index.js +2 -0
  250. package/dist/utils/telemetry/index.js.map +1 -0
  251. package/dist/utils/telemetry/tracing.d.ts +3 -0
  252. package/dist/utils/telemetry/tracing.d.ts.map +1 -0
  253. package/dist/utils/telemetry/tracing.js +4 -0
  254. package/dist/utils/telemetry/tracing.js.map +1 -0
  255. package/package.json +56 -0
@@ -0,0 +1,120 @@
1
+ import { z } from "zod";
2
+ import { resolveSessionServices } from "../utils/resolve-session.js";
3
+ const TOOL_NAME = "msads_get_entity";
4
+ const TOOL_TITLE = "Get Microsoft Ads Entity";
5
+ const TOOL_DESCRIPTION = `Retrieve one or more Microsoft Advertising entities by their IDs.
6
+
7
+ Returns full entity details for the specified entity type and IDs.
8
+
9
+ Some Microsoft Advertising query operations require parent or account context in addition to the IDs.`;
10
+ const BaseGetEntitySchema = {
11
+ entityIds: z.array(z.string()).min(1).describe("Array of entity IDs to retrieve"),
12
+ additionalParams: z
13
+ .record(z.unknown())
14
+ .optional()
15
+ .describe("Additional parameters such as ReturnAdditionalFields"),
16
+ };
17
+ export const GetEntityInputSchema = z
18
+ .discriminatedUnion("entityType", [
19
+ z.object({
20
+ entityType: z.literal("campaign"),
21
+ accountId: z.string().describe("AccountId required by GetCampaignsByIds"),
22
+ ...BaseGetEntitySchema,
23
+ }),
24
+ z.object({
25
+ entityType: z.literal("adGroup"),
26
+ campaignId: z.string().describe("CampaignId required by GetAdGroupsByIds"),
27
+ ...BaseGetEntitySchema,
28
+ }),
29
+ z.object({
30
+ entityType: z.literal("ad"),
31
+ adGroupId: z.string().describe("AdGroupId required by GetAdsByIds"),
32
+ ...BaseGetEntitySchema,
33
+ }),
34
+ z.object({
35
+ entityType: z.literal("keyword"),
36
+ adGroupId: z.string().describe("AdGroupId required by GetKeywordsByIds"),
37
+ ...BaseGetEntitySchema,
38
+ }),
39
+ z.object({
40
+ entityType: z.literal("adExtension"),
41
+ accountId: z.string().describe("AccountId required by GetAdExtensionsByIds"),
42
+ adExtensionType: z.string().describe("AdExtensionType required by GetAdExtensionsByIds"),
43
+ ...BaseGetEntitySchema,
44
+ }),
45
+ z.object({
46
+ entityType: z.literal("budget"),
47
+ ...BaseGetEntitySchema,
48
+ }),
49
+ z.object({
50
+ entityType: z.literal("audience"),
51
+ ...BaseGetEntitySchema,
52
+ }),
53
+ z.object({
54
+ entityType: z.literal("label"),
55
+ ...BaseGetEntitySchema,
56
+ }),
57
+ ])
58
+ .describe("Parameters for getting Microsoft Ads entities by ID");
59
+ export const GetEntityOutputSchema = z
60
+ .object({
61
+ entities: z.array(z.record(z.any())),
62
+ entityType: z.string(),
63
+ timestamp: z.string().datetime(),
64
+ })
65
+ .describe("Entity retrieval result");
66
+ export async function getEntityLogic(input, context, sdkContext) {
67
+ const { msadsService } = resolveSessionServices(sdkContext);
68
+ const additionalParams = {
69
+ ...(input.additionalParams ?? {}),
70
+ };
71
+ if ("accountId" in input) {
72
+ additionalParams.AccountId = Number(input.accountId);
73
+ }
74
+ if ("campaignId" in input) {
75
+ additionalParams.CampaignId = Number(input.campaignId);
76
+ }
77
+ if ("adGroupId" in input) {
78
+ additionalParams.AdGroupId = Number(input.adGroupId);
79
+ }
80
+ if ("adExtensionType" in input) {
81
+ additionalParams.AdExtensionType = input.adExtensionType;
82
+ }
83
+ const { entities: rawEntities } = await msadsService.getEntity(input.entityType, input.entityIds, additionalParams, context);
84
+ const entities = rawEntities;
85
+ return {
86
+ entities,
87
+ entityType: input.entityType,
88
+ timestamp: new Date().toISOString(),
89
+ };
90
+ }
91
+ export function getEntityResponseFormatter(result) {
92
+ return [
93
+ {
94
+ type: "text",
95
+ text: `Retrieved ${result.entities.length} ${result.entityType} entities\n\n${JSON.stringify(result.entities, null, 2)}\n\nTimestamp: ${result.timestamp}`,
96
+ },
97
+ ];
98
+ }
99
+ export const getEntityTool = {
100
+ name: TOOL_NAME,
101
+ title: TOOL_TITLE,
102
+ description: TOOL_DESCRIPTION,
103
+ inputSchema: GetEntityInputSchema,
104
+ outputSchema: GetEntityOutputSchema,
105
+ annotations: {
106
+ readOnlyHint: true,
107
+ openWorldHint: false,
108
+ idempotentHint: true,
109
+ destructiveHint: false,
110
+ },
111
+ inputExamples: [
112
+ {
113
+ label: "Get a campaign by ID",
114
+ input: { entityType: "campaign", entityIds: ["123456"], accountId: "789012" },
115
+ },
116
+ ],
117
+ logic: getEntityLogic,
118
+ responseFormatter: getEntityResponseFormatter,
119
+ };
120
+ //# sourceMappingURL=get-entity.tool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-entity.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-entity.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAIrE,MAAM,SAAS,GAAG,kBAAkB,CAAC;AACrC,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAC9C,MAAM,gBAAgB,GAAG;;;;sGAI6E,CAAC;AAEvG,MAAM,mBAAmB,GAAG;IAC1B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IACjF,gBAAgB,EAAE,CAAC;SAChB,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;SACnB,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;CACpE,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,kBAAkB,CAAC,YAAY,EAAE;IAChC,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;QACzE,GAAG,mBAAmB;KACvB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAChC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;QAC1E,GAAG,mBAAmB;KACvB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;QAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;QACnE,GAAG,mBAAmB;KACvB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;QACxE,GAAG,mBAAmB;KACvB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;QACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;QAC5E,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kDAAkD,CAAC;QACxF,GAAG,mBAAmB;KACvB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC/B,GAAG,mBAAmB;KACvB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QACjC,GAAG,mBAAmB;KACvB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC9B,GAAG,mBAAmB;KACvB,CAAC;CACH,CAAC;KACD,QAAQ,CAAC,qDAAqD,CAAC,CAAC;AAEnE,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IACpC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,yBAAyB,CAAC,CAAC;AAKvC,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAqB,EACrB,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,YAAY,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,gBAAgB,GAA4B;QAChD,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,EAAE,CAAC;KAClC,CAAC;IAEF,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;QACzB,gBAAgB,CAAC,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;QAC1B,gBAAgB,CAAC,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IACD,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;QACzB,gBAAgB,CAAC,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,iBAAiB,IAAI,KAAK,EAAE,CAAC;QAC/B,gBAAgB,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;IAC3D,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,MAAM,YAAY,CAAC,SAAS,CAC5D,KAAK,CAAC,UAA6B,EACnC,KAAK,CAAC,SAAS,EACf,gBAAgB,EAChB,OAAO,CACR,CAAC;IAEF,MAAM,QAAQ,GAAG,WAAmD,CAAC;IAErE,OAAO;QACL,QAAQ;QACR,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAuB;IAChE,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,aAAa,MAAM,CAAC,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,gBAAgB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,MAAM,CAAC,SAAS,EAAE;SAC3J;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,oBAAoB;IACjC,YAAY,EAAE,qBAAqB;IACnC,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,sBAAsB;YAC7B,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE;SAC9E;KACF;IACD,KAAK,EAAE,cAAc;IACrB,iBAAiB,EAAE,0BAA0B;CAC9C,CAAC"}
@@ -0,0 +1,280 @@
1
+ import { z } from "zod";
2
+ import type { RequestContext, McpTextContent, SdkContext } from "@cesteral/shared";
3
+ export declare const GetReportBreakdownsInputSchema: z.ZodEffects<z.ZodObject<{
4
+ reportType: z.ZodString;
5
+ accountId: z.ZodString;
6
+ columns: z.ZodArray<z.ZodString, "many">;
7
+ breakdownColumns: z.ZodArray<z.ZodString, "many">;
8
+ datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
9
+ startDate: z.ZodOptional<z.ZodString>;
10
+ endDate: z.ZodOptional<z.ZodString>;
11
+ aggregation: z.ZodOptional<z.ZodString>;
12
+ } & Omit<{
13
+ mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["summary", "rows"]>>>;
14
+ columns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
15
+ offset: z.ZodOptional<z.ZodNumber>;
16
+ maxRows: z.ZodOptional<z.ZodNumber>;
17
+ aggregateBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
18
+ aggregateMetrics: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["sum", "avg", "count", "min", "max"]>>>;
19
+ }, "columns">, "strip", z.ZodTypeAny, {
20
+ accountId: string;
21
+ reportType: string;
22
+ columns: string[];
23
+ mode: "rows" | "summary";
24
+ breakdownColumns: string[];
25
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
26
+ startDate?: string | undefined;
27
+ endDate?: string | undefined;
28
+ aggregation?: string | undefined;
29
+ offset?: number | undefined;
30
+ maxRows?: number | undefined;
31
+ aggregateBy?: string[] | undefined;
32
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
33
+ }, {
34
+ accountId: string;
35
+ reportType: string;
36
+ columns: string[];
37
+ breakdownColumns: string[];
38
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
39
+ startDate?: string | undefined;
40
+ endDate?: string | undefined;
41
+ aggregation?: string | undefined;
42
+ mode?: "rows" | "summary" | undefined;
43
+ offset?: number | undefined;
44
+ maxRows?: number | undefined;
45
+ aggregateBy?: string[] | undefined;
46
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
47
+ }>, {
48
+ accountId: string;
49
+ reportType: string;
50
+ columns: string[];
51
+ mode: "rows" | "summary";
52
+ breakdownColumns: string[];
53
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
54
+ startDate?: string | undefined;
55
+ endDate?: string | undefined;
56
+ aggregation?: string | undefined;
57
+ offset?: number | undefined;
58
+ maxRows?: number | undefined;
59
+ aggregateBy?: string[] | undefined;
60
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
61
+ }, {
62
+ accountId: string;
63
+ reportType: string;
64
+ columns: string[];
65
+ breakdownColumns: string[];
66
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
67
+ startDate?: string | undefined;
68
+ endDate?: string | undefined;
69
+ aggregation?: string | undefined;
70
+ mode?: "rows" | "summary" | undefined;
71
+ offset?: number | undefined;
72
+ maxRows?: number | undefined;
73
+ aggregateBy?: string[] | undefined;
74
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
75
+ }>;
76
+ export declare const GetReportBreakdownsOutputSchema: z.ZodObject<{
77
+ appliedColumns: z.ZodArray<z.ZodString, "many">;
78
+ timestamp: z.ZodString;
79
+ totalRows: z.ZodNumber;
80
+ returnedRows: z.ZodNumber;
81
+ truncated: z.ZodBoolean;
82
+ nextOffset: z.ZodNullable<z.ZodNumber>;
83
+ headers: z.ZodArray<z.ZodString, "many">;
84
+ selectedColumns: z.ZodArray<z.ZodString, "many">;
85
+ mode: z.ZodEnum<["summary", "rows"]>;
86
+ previewRows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
87
+ rows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
88
+ warnings: z.ZodArray<z.ZodString, "many">;
89
+ reportRequestId: z.ZodString;
90
+ }, "strip", z.ZodTypeAny, {
91
+ reportRequestId: string;
92
+ headers: string[];
93
+ totalRows: number;
94
+ timestamp: string;
95
+ mode: "rows" | "summary";
96
+ returnedRows: number;
97
+ truncated: boolean;
98
+ nextOffset: number | null;
99
+ selectedColumns: string[];
100
+ warnings: string[];
101
+ appliedColumns: string[];
102
+ rows?: Record<string, any>[] | undefined;
103
+ previewRows?: Record<string, any>[] | undefined;
104
+ }, {
105
+ reportRequestId: string;
106
+ headers: string[];
107
+ totalRows: number;
108
+ timestamp: string;
109
+ mode: "rows" | "summary";
110
+ returnedRows: number;
111
+ truncated: boolean;
112
+ nextOffset: number | null;
113
+ selectedColumns: string[];
114
+ warnings: string[];
115
+ appliedColumns: string[];
116
+ rows?: Record<string, any>[] | undefined;
117
+ previewRows?: Record<string, any>[] | undefined;
118
+ }>;
119
+ type GetReportBreakdownsInput = z.infer<typeof GetReportBreakdownsInputSchema>;
120
+ type GetReportBreakdownsOutput = z.infer<typeof GetReportBreakdownsOutputSchema>;
121
+ export declare function getReportBreakdownsLogic(input: GetReportBreakdownsInput, context: RequestContext, sdkContext?: SdkContext): Promise<GetReportBreakdownsOutput>;
122
+ export declare function getReportBreakdownsResponseFormatter(result: GetReportBreakdownsOutput): McpTextContent[];
123
+ export declare const getReportBreakdownsTool: {
124
+ name: string;
125
+ title: string;
126
+ description: string;
127
+ inputSchema: z.ZodEffects<z.ZodObject<{
128
+ reportType: z.ZodString;
129
+ accountId: z.ZodString;
130
+ columns: z.ZodArray<z.ZodString, "many">;
131
+ breakdownColumns: z.ZodArray<z.ZodString, "many">;
132
+ datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
133
+ startDate: z.ZodOptional<z.ZodString>;
134
+ endDate: z.ZodOptional<z.ZodString>;
135
+ aggregation: z.ZodOptional<z.ZodString>;
136
+ } & Omit<{
137
+ mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["summary", "rows"]>>>;
138
+ columns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
139
+ offset: z.ZodOptional<z.ZodNumber>;
140
+ maxRows: z.ZodOptional<z.ZodNumber>;
141
+ aggregateBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
142
+ aggregateMetrics: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["sum", "avg", "count", "min", "max"]>>>;
143
+ }, "columns">, "strip", z.ZodTypeAny, {
144
+ accountId: string;
145
+ reportType: string;
146
+ columns: string[];
147
+ mode: "rows" | "summary";
148
+ breakdownColumns: string[];
149
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
150
+ startDate?: string | undefined;
151
+ endDate?: string | undefined;
152
+ aggregation?: string | undefined;
153
+ offset?: number | undefined;
154
+ maxRows?: number | undefined;
155
+ aggregateBy?: string[] | undefined;
156
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
157
+ }, {
158
+ accountId: string;
159
+ reportType: string;
160
+ columns: string[];
161
+ breakdownColumns: string[];
162
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
163
+ startDate?: string | undefined;
164
+ endDate?: string | undefined;
165
+ aggregation?: string | undefined;
166
+ mode?: "rows" | "summary" | undefined;
167
+ offset?: number | undefined;
168
+ maxRows?: number | undefined;
169
+ aggregateBy?: string[] | undefined;
170
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
171
+ }>, {
172
+ accountId: string;
173
+ reportType: string;
174
+ columns: string[];
175
+ mode: "rows" | "summary";
176
+ breakdownColumns: string[];
177
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
178
+ startDate?: string | undefined;
179
+ endDate?: string | undefined;
180
+ aggregation?: string | undefined;
181
+ offset?: number | undefined;
182
+ maxRows?: number | undefined;
183
+ aggregateBy?: string[] | undefined;
184
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
185
+ }, {
186
+ accountId: string;
187
+ reportType: string;
188
+ columns: string[];
189
+ breakdownColumns: string[];
190
+ datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
191
+ startDate?: string | undefined;
192
+ endDate?: string | undefined;
193
+ aggregation?: string | undefined;
194
+ mode?: "rows" | "summary" | undefined;
195
+ offset?: number | undefined;
196
+ maxRows?: number | undefined;
197
+ aggregateBy?: string[] | undefined;
198
+ aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
199
+ }>;
200
+ outputSchema: z.ZodObject<{
201
+ appliedColumns: z.ZodArray<z.ZodString, "many">;
202
+ timestamp: z.ZodString;
203
+ totalRows: z.ZodNumber;
204
+ returnedRows: z.ZodNumber;
205
+ truncated: z.ZodBoolean;
206
+ nextOffset: z.ZodNullable<z.ZodNumber>;
207
+ headers: z.ZodArray<z.ZodString, "many">;
208
+ selectedColumns: z.ZodArray<z.ZodString, "many">;
209
+ mode: z.ZodEnum<["summary", "rows"]>;
210
+ previewRows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
211
+ rows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
212
+ warnings: z.ZodArray<z.ZodString, "many">;
213
+ reportRequestId: z.ZodString;
214
+ }, "strip", z.ZodTypeAny, {
215
+ reportRequestId: string;
216
+ headers: string[];
217
+ totalRows: number;
218
+ timestamp: string;
219
+ mode: "rows" | "summary";
220
+ returnedRows: number;
221
+ truncated: boolean;
222
+ nextOffset: number | null;
223
+ selectedColumns: string[];
224
+ warnings: string[];
225
+ appliedColumns: string[];
226
+ rows?: Record<string, any>[] | undefined;
227
+ previewRows?: Record<string, any>[] | undefined;
228
+ }, {
229
+ reportRequestId: string;
230
+ headers: string[];
231
+ totalRows: number;
232
+ timestamp: string;
233
+ mode: "rows" | "summary";
234
+ returnedRows: number;
235
+ truncated: boolean;
236
+ nextOffset: number | null;
237
+ selectedColumns: string[];
238
+ warnings: string[];
239
+ appliedColumns: string[];
240
+ rows?: Record<string, any>[] | undefined;
241
+ previewRows?: Record<string, any>[] | undefined;
242
+ }>;
243
+ annotations: {
244
+ readOnlyHint: boolean;
245
+ openWorldHint: boolean;
246
+ idempotentHint: boolean;
247
+ destructiveHint: boolean;
248
+ };
249
+ inputExamples: ({
250
+ label: string;
251
+ input: {
252
+ reportType: string;
253
+ accountId: string;
254
+ columns: string[];
255
+ breakdownColumns: string[];
256
+ datePreset: string;
257
+ mode: string;
258
+ startDate?: undefined;
259
+ endDate?: undefined;
260
+ aggregation?: undefined;
261
+ };
262
+ } | {
263
+ label: string;
264
+ input: {
265
+ reportType: string;
266
+ accountId: string;
267
+ columns: string[];
268
+ breakdownColumns: string[];
269
+ startDate: string;
270
+ endDate: string;
271
+ aggregation: string;
272
+ datePreset?: undefined;
273
+ mode?: undefined;
274
+ };
275
+ })[];
276
+ logic: typeof getReportBreakdownsLogic;
277
+ responseFormatter: typeof getReportBreakdownsResponseFormatter;
278
+ };
279
+ export {};
280
+ //# sourceMappingURL=get-report-breakdowns.tool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-report-breakdowns.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-report-breakdowns.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAYxB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAanF,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqCwC,CAAC;AAEpF,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOA,CAAC;AAE7C,KAAK,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAC/E,KAAK,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAEjF,wBAAsB,wBAAwB,CAC5C,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,cAAc,EACvB,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,yBAAyB,CAAC,CA2CpC;AAED,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,yBAAyB,GAChC,cAAc,EAAE,CAOlB;AAED,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCnC,CAAC"}
@@ -0,0 +1,138 @@
1
+ import { z } from "zod";
2
+ import { resolveSessionServices } from "../utils/resolve-session.js";
3
+ import { arrayRowsToRecords, createReportView, formatReportViewResponse, getReportViewFetchLimit, resolveDatePreset, DATE_PRESET_VALUES, ReportViewInputSchema, ReportViewOutputSchema, } from "@cesteral/shared";
4
+ const TOOL_NAME = "msads_get_report_breakdowns";
5
+ const TOOL_TITLE = "Get Microsoft Ads Report with Breakdowns";
6
+ const TOOL_DESCRIPTION = `Submit a Microsoft Advertising report with additional breakdown columns and poll until complete (blocking).
7
+
8
+ Like \`msads_get_report\` but adds \`breakdownColumns\` (dimension/segment columns) to segment data
9
+ by device, network, time-of-day, match type, and more.
10
+
11
+ **Common breakdown columns:** DeviceOS, Network, TopVsOther, MatchType, AccountName, TimePeriod
12
+
13
+ Results will include one row per combination of entity + breakdown dimensions.`;
14
+ export const GetReportBreakdownsInputSchema = z
15
+ .object({
16
+ reportType: z.string().describe("Report type (e.g., CampaignPerformanceReportRequest)"),
17
+ accountId: z.string().describe("Microsoft Ads Account ID"),
18
+ columns: z
19
+ .array(z.string())
20
+ .min(1)
21
+ .describe("Base metric/attribute columns (e.g., CampaignName, Impressions, Clicks, Spend)"),
22
+ breakdownColumns: z
23
+ .array(z.string())
24
+ .min(1)
25
+ .describe("Additional dimension columns to segment by (e.g., ['DeviceOS', 'Network']). Merged with base columns."),
26
+ datePreset: z
27
+ .enum(DATE_PRESET_VALUES)
28
+ .optional()
29
+ .describe("Preset date range. Use this OR startDate+endDate (not both)"),
30
+ startDate: z
31
+ .string()
32
+ .optional()
33
+ .describe("Start date (YYYY-MM-DD, required if datePreset not provided)"),
34
+ endDate: z
35
+ .string()
36
+ .optional()
37
+ .describe("End date (YYYY-MM-DD, required if datePreset not provided)"),
38
+ aggregation: z
39
+ .string()
40
+ .optional()
41
+ .describe("Time aggregation (Daily, Weekly, Monthly, Hourly). Default: Daily"),
42
+ })
43
+ .merge(ReportViewInputSchema.omit({ columns: true }))
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 running a Microsoft Ads report with breakdown columns");
46
+ export const GetReportBreakdownsOutputSchema = z
47
+ .object({
48
+ reportRequestId: z.string(),
49
+ ...ReportViewOutputSchema.shape,
50
+ appliedColumns: z.array(z.string()).describe("All columns used (base + breakdown)"),
51
+ timestamp: z.string().datetime(),
52
+ })
53
+ .describe("Report with breakdowns result");
54
+ export async function getReportBreakdownsLogic(input, context, sdkContext) {
55
+ const { msadsReportingService } = resolveSessionServices(sdkContext);
56
+ let resolvedStartDate = input.startDate;
57
+ let resolvedEndDate = input.endDate;
58
+ if (input.datePreset) {
59
+ const resolved = resolveDatePreset(input.datePreset);
60
+ resolvedStartDate = resolved.startDate;
61
+ resolvedEndDate = resolved.endDate;
62
+ }
63
+ const seenColumns = new Set(input.columns);
64
+ const uniqueBreakdownColumns = input.breakdownColumns.filter((c) => {
65
+ if (seenColumns.has(c))
66
+ return false;
67
+ seenColumns.add(c);
68
+ return true;
69
+ });
70
+ const allColumns = [...input.columns, ...uniqueBreakdownColumns];
71
+ const result = await msadsReportingService.getReport({
72
+ reportType: input.reportType,
73
+ accountId: input.accountId,
74
+ columns: allColumns,
75
+ dateRange: { startDate: resolvedStartDate, endDate: resolvedEndDate },
76
+ aggregation: input.aggregation,
77
+ }, getReportViewFetchLimit(input), context);
78
+ return {
79
+ reportRequestId: result.reportRequestId,
80
+ ...createReportView({
81
+ headers: result.headers,
82
+ rows: arrayRowsToRecords(result.headers, result.rows),
83
+ totalRows: result.totalRows,
84
+ input: { ...input, columns: allColumns },
85
+ }),
86
+ appliedColumns: allColumns,
87
+ timestamp: new Date().toISOString(),
88
+ };
89
+ }
90
+ export function getReportBreakdownsResponseFormatter(result) {
91
+ return [
92
+ {
93
+ type: "text",
94
+ text: `Report ${result.reportRequestId} completed\nApplied columns: ${result.appliedColumns.join(", ")}\n\n${formatReportViewResponse(result, "Report data")}\n\nTimestamp: ${result.timestamp}`,
95
+ },
96
+ ];
97
+ }
98
+ export const getReportBreakdownsTool = {
99
+ name: TOOL_NAME,
100
+ title: TOOL_TITLE,
101
+ description: TOOL_DESCRIPTION,
102
+ inputSchema: GetReportBreakdownsInputSchema,
103
+ outputSchema: GetReportBreakdownsOutputSchema,
104
+ annotations: {
105
+ readOnlyHint: true,
106
+ openWorldHint: false,
107
+ idempotentHint: false,
108
+ destructiveHint: false,
109
+ },
110
+ inputExamples: [
111
+ {
112
+ label: "Campaign performance broken down by device",
113
+ input: {
114
+ reportType: "CampaignPerformanceReportRequest",
115
+ accountId: "123456789",
116
+ columns: ["CampaignName", "Impressions", "Clicks", "Spend"],
117
+ breakdownColumns: ["DeviceOS", "Network"],
118
+ datePreset: "LAST_30_DAYS",
119
+ mode: "summary",
120
+ },
121
+ },
122
+ {
123
+ label: "Keyword performance broken down by match type and network",
124
+ input: {
125
+ reportType: "KeywordPerformanceReportRequest",
126
+ accountId: "123456789",
127
+ columns: ["Keyword", "Impressions", "Clicks", "Spend", "AverageCpc"],
128
+ breakdownColumns: ["MatchType", "Network", "TopVsOther"],
129
+ startDate: "2026-01-01",
130
+ endDate: "2026-01-31",
131
+ aggregation: "Daily",
132
+ },
133
+ },
134
+ ],
135
+ logic: getReportBreakdownsLogic,
136
+ responseFormatter: getReportBreakdownsResponseFormatter,
137
+ };
138
+ //# sourceMappingURL=get-report-breakdowns.tool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-report-breakdowns.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-report-breakdowns.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,kBAAkB,CAAC;AAG1B,MAAM,SAAS,GAAG,6BAA6B,CAAC;AAChD,MAAM,UAAU,GAAG,0CAA0C,CAAC;AAC9D,MAAM,gBAAgB,GAAG;;;;;;;+EAOsD,CAAC;AAEhF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;IACvF,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IAC1D,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,gFAAgF,CAAC;IAC7F,gBAAgB,EAAE,CAAC;SAChB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,uGAAuG,CACxG;IACH,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,kBAAkB,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,8DAA8D,CAAC;IAC3E,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,4DAA4D,CAAC;IACzE,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,mEAAmE,CAAC;CACjF,CAAC;KACD,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;KACpD,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,sEAAsE,CAAC,CAAC;AAEpF,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC;KAC7C,MAAM,CAAC;IACN,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,GAAG,sBAAsB,CAAC,KAAK;IAC/B,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IACnF,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,+BAA+B,CAAC,CAAC;AAK7C,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,KAA+B,EAC/B,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,qBAAqB,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAErE,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;IAGD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,sBAAsB,GAAG,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACjE,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QACrC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,sBAAsB,CAAC,CAAC;IAEjE,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAClD;QACE,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,OAAO,EAAE,UAAU;QACnB,SAAS,EAAE,EAAE,SAAS,EAAE,iBAAkB,EAAE,OAAO,EAAE,eAAgB,EAAE;QACvE,WAAW,EAAE,KAAK,CAAC,WAAW;KAC/B,EACD,uBAAuB,CAAC,KAAK,CAAC,EAC9B,OAAO,CACR,CAAC;IAEF,OAAO;QACL,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,GAAG,gBAAgB,CAAC;YAClB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC;YACrD,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE;SACzC,CAAC;QACF,cAAc,EAAE,UAAU;QAC1B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oCAAoC,CAClD,MAAiC;IAEjC,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,UAAU,MAAM,CAAC,eAAe,gCAAgC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,wBAAwB,CAAC,MAAM,EAAE,aAAa,CAAC,kBAAkB,MAAM,CAAC,SAAS,EAAE;SACjM;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,8BAA8B;IAC3C,YAAY,EAAE,+BAA+B;IAC7C,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK;QACrB,eAAe,EAAE,KAAK;KACvB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,4CAA4C;YACnD,KAAK,EAAE;gBACL,UAAU,EAAE,kCAAkC;gBAC9C,SAAS,EAAE,WAAW;gBACtB,OAAO,EAAE,CAAC,cAAc,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,CAAC;gBAC3D,gBAAgB,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC;gBACzC,UAAU,EAAE,cAAc;gBAC1B,IAAI,EAAE,SAAS;aAChB;SACF;QACD;YACE,KAAK,EAAE,2DAA2D;YAClE,KAAK,EAAE;gBACL,UAAU,EAAE,iCAAiC;gBAC7C,SAAS,EAAE,WAAW;gBACtB,OAAO,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,CAAC;gBACpE,gBAAgB,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,CAAC;gBACxD,SAAS,EAAE,YAAY;gBACvB,OAAO,EAAE,YAAY;gBACrB,WAAW,EAAE,OAAO;aACrB;SACF;KACF;IACD,KAAK,EAAE,wBAAwB;IAC/B,iBAAiB,EAAE,oCAAoC;CACxD,CAAC"}