@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.
- package/LICENSE.md +201 -0
- package/README.md +179 -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/msads-auth-adapter.d.ts +27 -0
- package/dist/auth/msads-auth-adapter.d.ts.map +1 -0
- package/dist/auth/msads-auth-adapter.js +79 -0
- package/dist/auth/msads-auth-adapter.js.map +1 -0
- package/dist/auth/msads-auth-strategy.d.ts +8 -0
- package/dist/auth/msads-auth-strategy.d.ts.map +1 -0
- package/dist/auth/msads-auth-strategy.js +36 -0
- package/dist/auth/msads-auth-strategy.js.map +1 -0
- package/dist/config/index.d.ts +112 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +56 -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 +47 -0
- package/dist/index.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 +54 -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 +147 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.js +73 -0
- package/dist/mcp-server/prompts/definitions/google-import-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.js +55 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.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 +47 -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 +49 -0
- package/dist/mcp-server/prompts/index.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 +84 -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 +54 -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 +54 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/field-rules.resource.d.ts +3 -0
- package/dist/mcp-server/resources/definitions/field-rules.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/field-rules.resource.js +28 -0
- package/dist/mcp-server/resources/definitions/field-rules.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/index.d.ts +7 -0
- package/dist/mcp-server/resources/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/index.js +79 -0
- package/dist/mcp-server/resources/definitions/index.js.map +1 -0
- package/dist/mcp-server/resources/definitions/reporting-reference.resource.d.ts +3 -0
- package/dist/mcp-server/resources/definitions/reporting-reference.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/reporting-reference.resource.js +64 -0
- package/dist/mcp-server/resources/definitions/reporting-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/resources/utils/field-rules.d.ts +9 -0
- package/dist/mcp-server/resources/utils/field-rules.d.ts.map +1 -0
- package/dist/mcp-server/resources/utils/field-rules.js +106 -0
- package/dist/mcp-server/resources/utils/field-rules.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 +142 -0
- package/dist/mcp-server/server.js.map +1 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.d.ts +175 -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 +124 -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 +83 -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 +68 -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 +95 -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 +102 -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 +151 -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 +112 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.d.ts +111 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.js +73 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.d.ts +81 -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 +74 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/create-report-schedule.tool.d.ts +160 -0
- package/dist/mcp-server/tools/definitions/create-report-schedule.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/create-report-schedule.tool.js +108 -0
- package/dist/mcp-server/tools/definitions/create-report-schedule.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.d.ts +98 -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 +94 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.d.ts +79 -0
- package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.js +88 -0
- package/dist/mcp-server/tools/definitions/delete-report-schedule.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.d.ts +287 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.js +85 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-details.tool.d.ts +68 -0
- package/dist/mcp-server/tools/definitions/get-ad-details.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-details.tool.js +85 -0
- package/dist/mcp-server/tools/definitions/get-ad-details.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.d.ts +68 -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 +90 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.d.ts +285 -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 +120 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts +280 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js +138 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.d.ts +260 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.js +118 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/import-from-google.tool.d.ts +79 -0
- package/dist/mcp-server/tools/definitions/import-from-google.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/import-from-google.tool.js +88 -0
- package/dist/mcp-server/tools/definitions/import-from-google.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/index.d.ts +3 -0
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/index.js +53 -0
- package/dist/mcp-server/tools/definitions/index.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-accounts.tool.d.ts +135 -0
- package/dist/mcp-server/tools/definitions/list-accounts.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-accounts.tool.js +88 -0
- package/dist/mcp-server/tools/definitions/list-accounts.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.d.ts +120 -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 +100 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-report-schedules.tool.d.ts +47 -0
- package/dist/mcp-server/tools/definitions/list-report-schedules.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-report-schedules.tool.js +57 -0
- package/dist/mcp-server/tools/definitions/list-report-schedules.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.d.ts +81 -0
- package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.js +81 -0
- package/dist/mcp-server/tools/definitions/manage-ad-extensions.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/manage-criterions.tool.d.ts +90 -0
- package/dist/mcp-server/tools/definitions/manage-criterions.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/manage-criterions.tool.js +92 -0
- package/dist/mcp-server/tools/definitions/manage-criterions.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.d.ts +79 -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 +105 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.d.ts +132 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.js +94 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.d.ts +79 -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 +64 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.d.ts +174 -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 +142 -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 +20 -0
- package/dist/mcp-server/tools/utils/entity-mapping.d.ts.map +1 -0
- package/dist/mcp-server/tools/utils/entity-mapping.js +118 -0
- package/dist/mcp-server/tools/utils/entity-mapping.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 +55 -0
- package/dist/mcp-server/transports/streamable-http-transport.d.ts.map +1 -0
- package/dist/mcp-server/transports/streamable-http-transport.js +86 -0
- package/dist/mcp-server/transports/streamable-http-transport.js.map +1 -0
- package/dist/services/msads/msads-http-client.d.ts +16 -0
- package/dist/services/msads/msads-http-client.d.ts.map +1 -0
- package/dist/services/msads/msads-http-client.js +89 -0
- package/dist/services/msads/msads-http-client.js.map +1 -0
- package/dist/services/msads/msads-reporting-service.d.ts +58 -0
- package/dist/services/msads/msads-reporting-service.d.ts.map +1 -0
- package/dist/services/msads/msads-reporting-service.js +153 -0
- package/dist/services/msads/msads-reporting-service.js.map +1 -0
- package/dist/services/msads/msads-service.d.ts +54 -0
- package/dist/services/msads/msads-service.d.ts.map +1 -0
- package/dist/services/msads/msads-service.js +179 -0
- package/dist/services/msads/msads-service.js.map +1 -0
- package/dist/services/msads/rate-limit-keys.d.ts +3 -0
- package/dist/services/msads/rate-limit-keys.d.ts.map +1 -0
- package/dist/services/msads/rate-limit-keys.js +3 -0
- package/dist/services/msads/rate-limit-keys.js.map +1 -0
- package/dist/services/msads/types.d.ts +196 -0
- package/dist/services/msads/types.d.ts.map +1 -0
- package/dist/services/msads/types.js +47 -0
- package/dist/services/msads/types.js.map +1 -0
- package/dist/services/session-services.d.ts +22 -0
- package/dist/services/session-services.d.ts.map +1 -0
- package/dist/services/session-services.js +22 -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 +56 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# @cesteral/msads-mcp
|
|
2
|
+
|
|
3
|
+
Microsoft Advertising MCP Server - campaign management and reporting via Microsoft Advertising API v13 JSON endpoints.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
Management and reporting server for Microsoft Advertising (Bing Ads). Provides
|
|
8
|
+
full CRUD operations on campaigns, ad groups, ads, keywords, budgets, ad
|
|
9
|
+
extensions, audiences, and labels. Includes async reporting with configurable
|
|
10
|
+
aggregation, Google Ads import via ImportJobs API, and ad extension management.
|
|
11
|
+
Designed for AI agents to manage Microsoft Ads campaigns programmatically
|
|
12
|
+
through the Model Context Protocol.
|
|
13
|
+
|
|
14
|
+
## Features
|
|
15
|
+
|
|
16
|
+
- **Per-session Bearer token auth** via `MsAdsBearerAuthStrategy`
|
|
17
|
+
- **Streamable HTTP + stdio transports** via Hono + `@hono/mcp`
|
|
18
|
+
- **OpenTelemetry** instrumentation for traces and metrics
|
|
19
|
+
- **Rate limiting** via shared `RateLimiter` class
|
|
20
|
+
- **Structured logging** via Pino
|
|
21
|
+
- **Google Ads import** via ImportJobs API
|
|
22
|
+
|
|
23
|
+
## MCP Tools
|
|
24
|
+
|
|
25
|
+
### Core CRUD
|
|
26
|
+
|
|
27
|
+
| Tool | Description |
|
|
28
|
+
| --------------------- | ------------------------------------------------------- |
|
|
29
|
+
| `msads_list_entities` | List Microsoft Ads entities with filters and pagination |
|
|
30
|
+
| `msads_get_entity` | Get a single entity by ID |
|
|
31
|
+
| `msads_create_entity` | Create a new entity |
|
|
32
|
+
| `msads_update_entity` | Update an existing entity |
|
|
33
|
+
| `msads_delete_entity` | Delete an entity |
|
|
34
|
+
| `msads_list_accounts` | List accessible ad accounts |
|
|
35
|
+
|
|
36
|
+
### Reporting
|
|
37
|
+
|
|
38
|
+
All reporting tools below accept the shared bounded report-view params: `mode` (`"summary"` default — headers + counts + 10-row preview, or `"rows"` for a paginated rows page), `columns` (project to selected columns), `offset` (zero-based pagination), and `maxRows` (page size; default 10 for summary, 50 for rows; hard cap 200).
|
|
39
|
+
|
|
40
|
+
| Tool | Description |
|
|
41
|
+
| ----------------------------- | ---------------------------------------------- |
|
|
42
|
+
| `msads_get_report` | Submit and download async report (blocking) |
|
|
43
|
+
| `msads_submit_report` | Submit async report (non-blocking) |
|
|
44
|
+
| `msads_check_report_status` | Check report status |
|
|
45
|
+
| `msads_download_report` | Download and parse report results |
|
|
46
|
+
| `msads_get_report_breakdowns` | Async report with additional breakdown columns |
|
|
47
|
+
|
|
48
|
+
### Bulk Operations
|
|
49
|
+
|
|
50
|
+
| Tool | Description |
|
|
51
|
+
| ---------------------------- | --------------------- |
|
|
52
|
+
| `msads_bulk_create_entities` | Batch create entities |
|
|
53
|
+
| `msads_bulk_update_entities` | Batch update entities |
|
|
54
|
+
| `msads_bulk_update_status` | Batch status updates |
|
|
55
|
+
| `msads_adjust_bids` | Batch bid adjustments |
|
|
56
|
+
|
|
57
|
+
### Specialized
|
|
58
|
+
|
|
59
|
+
| Tool | Description |
|
|
60
|
+
| ---------------------------- | ------------------------------------------------ |
|
|
61
|
+
| `msads_manage_ad_extensions` | Manage ad extensions (sitelinks, callouts, etc.) |
|
|
62
|
+
| `msads_manage_criterions` | Manage targeting criterions |
|
|
63
|
+
| `msads_search_targeting` | Search available targeting options |
|
|
64
|
+
| `msads_get_ad_details` | Get stored ad details (copy, URLs, status) |
|
|
65
|
+
| `msads_validate_entity` | Validate entity payload |
|
|
66
|
+
| `msads_import_from_google` | Import campaigns from Google Ads |
|
|
67
|
+
|
|
68
|
+
## Supported Entity Types
|
|
69
|
+
|
|
70
|
+
| Entity Type | API Service Path | Parent Entity | Batch Limit | Notes |
|
|
71
|
+
| ------------- | ----------------- | ------------- | ----------- | ---------------------------------------------- |
|
|
72
|
+
| `campaign` | `/Campaigns/*` | Account | 100 | Top-level entity; requires budget reference |
|
|
73
|
+
| `adGroup` | `/AdGroups/*` | Campaign | 1000 | Requires parent `CampaignId` |
|
|
74
|
+
| `ad` | `/Ads/*` | Ad Group | 50 | Requires parent `AdGroupId` |
|
|
75
|
+
| `keyword` | `/Keywords/*` | Ad Group | 1000 | Requires parent `AdGroupId` |
|
|
76
|
+
| `budget` | `/Budgets/*` | Account | 100 | Shared budgets; create before campaigns |
|
|
77
|
+
| `adExtension` | `/AdExtensions/*` | Account | 100 | Sitelinks, callouts, structured snippets, etc. |
|
|
78
|
+
| `audience` | `/Audiences/*` | Account | 100 | Remarketing lists, custom audiences |
|
|
79
|
+
| `label` | `/Labels/*` | Account | 100 | For organizing and filtering entities |
|
|
80
|
+
|
|
81
|
+
**Entity Hierarchy:** Account > Budget > Campaign > Ad Group > Ad / Keyword
|
|
82
|
+
|
|
83
|
+
## Current Status
|
|
84
|
+
|
|
85
|
+
**Phase: Production-Ready**
|
|
86
|
+
|
|
87
|
+
All listed tools are implemented against the Microsoft Advertising API v13 JSON endpoints.
|
|
88
|
+
|
|
89
|
+
## Development
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
# Install dependencies
|
|
93
|
+
pnpm install
|
|
94
|
+
|
|
95
|
+
# Run in development mode
|
|
96
|
+
pnpm run dev:http
|
|
97
|
+
|
|
98
|
+
# Build
|
|
99
|
+
pnpm run build
|
|
100
|
+
|
|
101
|
+
# Start production server
|
|
102
|
+
pnpm run start
|
|
103
|
+
|
|
104
|
+
# Type check
|
|
105
|
+
pnpm run typecheck
|
|
106
|
+
|
|
107
|
+
# Run tests
|
|
108
|
+
pnpm run test
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Environment Variables
|
|
112
|
+
|
|
113
|
+
### Server Configuration
|
|
114
|
+
|
|
115
|
+
- `MSADS_MCP_PORT`: Server port (default: 3013)
|
|
116
|
+
- `MCP_AUTH_MODE`: Authentication mode - `msads-bearer` (default), `jwt`, or `none`
|
|
117
|
+
- `MCP_AUTH_SECRET_KEY`: Required when `MCP_AUTH_MODE=jwt`
|
|
118
|
+
|
|
119
|
+
### Stdio Mode Credentials
|
|
120
|
+
|
|
121
|
+
When running in stdio transport mode (e.g., Claude Desktop), set these environment variables instead of passing HTTP headers:
|
|
122
|
+
|
|
123
|
+
- `MSADS_ACCESS_TOKEN`: Microsoft Ads OAuth2 access token
|
|
124
|
+
- `MSADS_DEVELOPER_TOKEN`: Per-app developer token (from Microsoft Advertising Developer Portal)
|
|
125
|
+
- `MSADS_CUSTOMER_ID`: Manager account (customer) ID
|
|
126
|
+
- `MSADS_ACCOUNT_ID`: Ad account (customer account) ID
|
|
127
|
+
|
|
128
|
+
### Advanced Configuration
|
|
129
|
+
|
|
130
|
+
- `MSADS_CAMPAIGN_API_BASE_URL`: Campaign Management API base URL (default: `https://campaign.api.bingads.microsoft.com/CampaignManagement/v13`)
|
|
131
|
+
- `MSADS_REPORTING_API_BASE_URL`: Reporting API base URL (default: `https://reporting.api.bingads.microsoft.com/Reporting/v13`)
|
|
132
|
+
- `MSADS_CUSTOMER_API_BASE_URL`: Customer Management API base URL (default: `https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13`)
|
|
133
|
+
- `MSADS_RATE_LIMIT_PER_MINUTE`: Rate limit per minute (default: 10)
|
|
134
|
+
- `MSADS_REPORT_POLL_INTERVAL_MS`: Report poll interval in ms (default: 3000)
|
|
135
|
+
- `MSADS_REPORT_MAX_POLL_ATTEMPTS`: Max report poll attempts (default: 30)
|
|
136
|
+
|
|
137
|
+
## Architecture
|
|
138
|
+
|
|
139
|
+
### Key Components
|
|
140
|
+
|
|
141
|
+
- **`MsAdsHttpClient`** (`src/services/msads/msads-http-client.ts`) — HTTP client for Microsoft Advertising API v13 JSON endpoints with retry on 429/5xx, timeout handling, and OpenTelemetry tracing
|
|
142
|
+
- **`MsAdsService`** (`src/services/msads/msads-service.ts`) — Generic entity CRUD wrapping `MsAdsHttpClient`; routes operations to collection and query endpoints via entity mapping
|
|
143
|
+
- **`MsAdsReportingService`** (`src/services/msads/msads-reporting-service.ts`) — Async reporting flow: SubmitGenerateReport, PollGenerateReport, download CSV/TSV
|
|
144
|
+
- **`MsAdsBearerAuthStrategy`** (`src/auth/msads-auth-strategy.ts`) — Extracts OAuth2 token + 3 additional credentials from HTTP headers; validates via Customer Management API
|
|
145
|
+
- **`MsAdsAccessTokenAdapter`** (`src/auth/msads-auth-adapter.ts`) — Holds pre-generated OAuth2 token plus developer token and account identifiers; validates via the Customer Management user query endpoint
|
|
146
|
+
- **`SessionServiceStore`** — Per-session service instances keyed by session ID (created on connect, cleaned up on close/timeout)
|
|
147
|
+
|
|
148
|
+
### Key Gotchas
|
|
149
|
+
|
|
150
|
+
- **All operations use POST** — Microsoft Advertising JSON endpoints use POST for both mutations and queries.
|
|
151
|
+
- **4 auth headers required per request** — Every JSON API call must include `Authorization: Bearer <token>`, `DeveloperToken`, `CustomerId`, and `CustomerAccountId`.
|
|
152
|
+
- **No hard delete for most entities** — Use status change (e.g., set status to `Deleted` or `Paused`) rather than expecting a true DELETE operation. The `delete_entity` tool wraps the platform's delete endpoint, but behavior varies by entity type.
|
|
153
|
+
- **Collection + query routing** — Mutations use collection endpoints such as `/Campaigns`, while reads use query endpoints such as `/Campaigns/QueryByAccountId` and `/Campaigns/QueryByIds`.
|
|
154
|
+
- **Batch limits vary by entity type** — Ads have a limit of 50 per batch, while keywords and ad groups allow up to 1000.
|
|
155
|
+
|
|
156
|
+
### Transport
|
|
157
|
+
|
|
158
|
+
- **Streamable HTTP**: MCP protocol via Hono + `@hono/mcp`
|
|
159
|
+
- **Health check**: `/health` endpoint
|
|
160
|
+
|
|
161
|
+
## Contributing
|
|
162
|
+
|
|
163
|
+
See root [CLAUDE.md](../../CLAUDE.md) for development guidelines, build system details, and monorepo conventions. See the [root README](../../README.md) for full architecture context.
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
## Get Started
|
|
168
|
+
|
|
169
|
+
**Self-host**: Follow the [deployment guide](../../docs/guides/deployment-instructions.md) to run this server on your own infrastructure.
|
|
170
|
+
|
|
171
|
+
**Cesteral Intelligence**: [Request access](https://cesteral.com/integrations/microsoft-ads?utm_source=github&utm_medium=package-readme&utm_campaign=msads-mcp) -- governed execution with credential brokering, approvals, audit, and multi-tenant access.
|
|
172
|
+
|
|
173
|
+
**Book a workflow demo**: [See it in action](mailto:sales@cesteral.com?subject=Workflow%20demo%20-%20Microsoft%20Ads%20MCP) with your own ad accounts.
|
|
174
|
+
|
|
175
|
+
**Compare options**: [OSS connectors vs Cesteral Intelligence](https://cesteral.com/compare?utm_source=github&utm_medium=package-readme&utm_campaign=msads-mcp)
|
|
176
|
+
|
|
177
|
+
## License
|
|
178
|
+
|
|
179
|
+
Apache License 2.0 — see [LICENSE](../../LICENSE.md) for details. This package is part of Cesteral's open-source connector layer; managed hosting and higher-level governance features live outside this repository.
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { type MsAdsAuthAdapter, MsAdsAccessTokenAdapter, parseMsAdsTokenFromHeaders, getMsAdsDeveloperTokenFromHeaders, getMsAdsCustomerIdFromHeaders, getMsAdsAccountIdFromHeaders, getMsAdsCredentialFingerprint, } from "./msads-auth-adapter.js";
|
|
2
|
+
export { MsAdsBearerAuthStrategy } from "./msads-auth-strategy.js";
|
|
3
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,0BAA0B,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { MsAdsAccessTokenAdapter, parseMsAdsTokenFromHeaders, getMsAdsDeveloperTokenFromHeaders, getMsAdsCustomerIdFromHeaders, getMsAdsAccountIdFromHeaders, getMsAdsCredentialFingerprint, } from "./msads-auth-adapter.js";
|
|
2
|
+
export { MsAdsBearerAuthStrategy } from "./msads-auth-strategy.js";
|
|
3
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,uBAAuB,EACvB,0BAA0B,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export interface MsAdsAuthAdapter {
|
|
2
|
+
getAccessToken(): Promise<string>;
|
|
3
|
+
validate(): Promise<void>;
|
|
4
|
+
readonly developerToken: string;
|
|
5
|
+
readonly customerId: string;
|
|
6
|
+
readonly accountId: string;
|
|
7
|
+
readonly userId: string;
|
|
8
|
+
}
|
|
9
|
+
export declare class MsAdsAccessTokenAdapter implements MsAdsAuthAdapter {
|
|
10
|
+
private readonly accessToken;
|
|
11
|
+
readonly developerToken: string;
|
|
12
|
+
readonly customerId: string;
|
|
13
|
+
readonly accountId: string;
|
|
14
|
+
private readonly customerApiBaseUrl;
|
|
15
|
+
private validated;
|
|
16
|
+
private _userId;
|
|
17
|
+
constructor(accessToken: string, developerToken: string, customerId: string, accountId: string, customerApiBaseUrl?: string);
|
|
18
|
+
get userId(): string;
|
|
19
|
+
getAccessToken(): Promise<string>;
|
|
20
|
+
validate(): Promise<void>;
|
|
21
|
+
}
|
|
22
|
+
export declare function parseMsAdsTokenFromHeaders(headers: Record<string, string | string[] | undefined>): string;
|
|
23
|
+
export declare function getMsAdsDeveloperTokenFromHeaders(headers: Record<string, string | string[] | undefined>): string;
|
|
24
|
+
export declare function getMsAdsCustomerIdFromHeaders(headers: Record<string, string | string[] | undefined>): string;
|
|
25
|
+
export declare function getMsAdsAccountIdFromHeaders(headers: Record<string, string | string[] | undefined>): string;
|
|
26
|
+
export declare function getMsAdsCredentialFingerprint(accessToken: string, developerToken: string, accountId: string): string;
|
|
27
|
+
//# sourceMappingURL=msads-auth-adapter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"msads-auth-adapter.d.ts","sourceRoot":"","sources":["../../src/auth/msads-auth-adapter.ts"],"names":[],"mappings":"AAmBA,MAAM,WAAW,gBAAgB;IAC/B,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAClC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAYD,qBAAa,uBAAwB,YAAW,gBAAgB;IAK5D,OAAO,CAAC,QAAQ,CAAC,WAAW;aACZ,cAAc,EAAE,MAAM;aACtB,UAAU,EAAE,MAAM;aAClB,SAAS,EAAE,MAAM;IACjC,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IARrC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,OAAO,CAAM;gBAGF,WAAW,EAAE,MAAM,EACpB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EAChB,kBAAkB,GAAE,MAAgF;IAGvH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAEK,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CA+BhC;AAMD,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GACrD,MAAM,CAUR;AAKD,wBAAgB,iCAAiC,CAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GACrD,MAAM,CAMR;AAKD,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GACrD,MAAM,CAMR;AAKD,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GACrD,MAAM,CAMR;AAKD,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,MAAM,GAChB,MAAM,CAER"}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { extractHeader, fetchWithTimeout, fingerprintCredentials, JsonRpcErrorCode, McpError, } from "@cesteral/shared";
|
|
2
|
+
export class MsAdsAccessTokenAdapter {
|
|
3
|
+
accessToken;
|
|
4
|
+
developerToken;
|
|
5
|
+
customerId;
|
|
6
|
+
accountId;
|
|
7
|
+
customerApiBaseUrl;
|
|
8
|
+
validated = false;
|
|
9
|
+
_userId = "";
|
|
10
|
+
constructor(accessToken, developerToken, customerId, accountId, customerApiBaseUrl = "https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13") {
|
|
11
|
+
this.accessToken = accessToken;
|
|
12
|
+
this.developerToken = developerToken;
|
|
13
|
+
this.customerId = customerId;
|
|
14
|
+
this.accountId = accountId;
|
|
15
|
+
this.customerApiBaseUrl = customerApiBaseUrl;
|
|
16
|
+
}
|
|
17
|
+
get userId() {
|
|
18
|
+
return this._userId;
|
|
19
|
+
}
|
|
20
|
+
async getAccessToken() {
|
|
21
|
+
return this.accessToken;
|
|
22
|
+
}
|
|
23
|
+
async validate() {
|
|
24
|
+
if (this.validated)
|
|
25
|
+
return;
|
|
26
|
+
const response = await fetchWithTimeout(`${this.customerApiBaseUrl}/User/Query`, 10_000, undefined, {
|
|
27
|
+
method: "POST",
|
|
28
|
+
headers: {
|
|
29
|
+
Authorization: `Bearer ${this.accessToken}`,
|
|
30
|
+
DeveloperToken: this.developerToken,
|
|
31
|
+
"Content-Type": "application/json",
|
|
32
|
+
},
|
|
33
|
+
body: JSON.stringify({ UserId: null }),
|
|
34
|
+
});
|
|
35
|
+
if (!response.ok) {
|
|
36
|
+
const errorBody = await response.text().catch(() => "");
|
|
37
|
+
throw new McpError(JsonRpcErrorCode.Unauthorized, `Microsoft Ads token validation failed: ${response.status} ${response.statusText}`, { body: errorBody.substring(0, 200) });
|
|
38
|
+
}
|
|
39
|
+
const data = (await response.json());
|
|
40
|
+
this._userId = String(data.UserId ?? "unknown");
|
|
41
|
+
this.validated = true;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
export function parseMsAdsTokenFromHeaders(headers) {
|
|
45
|
+
const authHeader = extractHeader(headers, "authorization");
|
|
46
|
+
if (!authHeader) {
|
|
47
|
+
throw new Error("Missing required Authorization header");
|
|
48
|
+
}
|
|
49
|
+
const match = authHeader.match(/^Bearer\s+(.+)$/i);
|
|
50
|
+
if (!match || !match[1]) {
|
|
51
|
+
throw new Error("Authorization header must use Bearer scheme");
|
|
52
|
+
}
|
|
53
|
+
return match[1];
|
|
54
|
+
}
|
|
55
|
+
export function getMsAdsDeveloperTokenFromHeaders(headers) {
|
|
56
|
+
const token = extractHeader(headers, "x-msads-developer-token");
|
|
57
|
+
if (!token) {
|
|
58
|
+
throw new Error("Missing required X-MSAds-Developer-Token header");
|
|
59
|
+
}
|
|
60
|
+
return token;
|
|
61
|
+
}
|
|
62
|
+
export function getMsAdsCustomerIdFromHeaders(headers) {
|
|
63
|
+
const id = extractHeader(headers, "x-msads-customer-id");
|
|
64
|
+
if (!id) {
|
|
65
|
+
throw new Error("Missing required X-MSAds-Customer-Id header");
|
|
66
|
+
}
|
|
67
|
+
return id;
|
|
68
|
+
}
|
|
69
|
+
export function getMsAdsAccountIdFromHeaders(headers) {
|
|
70
|
+
const id = extractHeader(headers, "x-msads-account-id");
|
|
71
|
+
if (!id) {
|
|
72
|
+
throw new Error("Missing required X-MSAds-Account-Id header");
|
|
73
|
+
}
|
|
74
|
+
return id;
|
|
75
|
+
}
|
|
76
|
+
export function getMsAdsCredentialFingerprint(accessToken, developerToken, accountId) {
|
|
77
|
+
return fingerprintCredentials(accessToken, developerToken, accountId);
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=msads-auth-adapter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"msads-auth-adapter.js","sourceRoot":"","sources":["../../src/auth/msads-auth-adapter.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,QAAQ,GACT,MAAM,kBAAkB,CAAC;AA6B1B,MAAM,OAAO,uBAAuB;IAKf;IACD;IACA;IACA;IACC;IARX,SAAS,GAAG,KAAK,CAAC;IAClB,OAAO,GAAG,EAAE,CAAC;IAErB,YACmB,WAAmB,EACpB,cAAsB,EACtB,UAAkB,EAClB,SAAiB,EAChB,qBAA6B,uEAAuE;QAJpG,gBAAW,GAAX,WAAW,CAAQ;QACpB,mBAAc,GAAd,cAAc,CAAQ;QACtB,eAAU,GAAV,UAAU,CAAQ;QAClB,cAAS,GAAT,SAAS,CAAQ;QAChB,uBAAkB,GAAlB,kBAAkB,CAAkF;IACpH,CAAC;IAEJ,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAE3B,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CACrC,GAAG,IAAI,CAAC,kBAAkB,aAAa,EACvC,MAAM,EACN,SAAS,EACT;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;gBAC3C,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;SACvC,CACF,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YACxD,MAAM,IAAI,QAAQ,CAChB,gBAAgB,CAAC,YAAY,EAC7B,0CAA0C,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,EAClF,EAAE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CACtC,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAoB,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;CACF;AAMD,MAAM,UAAU,0BAA0B,CACxC,OAAsD;IAEtD,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC3D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACnD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAKD,MAAM,UAAU,iCAAiC,CAC/C,OAAsD;IAEtD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;IAChE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAKD,MAAM,UAAU,6BAA6B,CAC3C,OAAsD;IAEtD,MAAM,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC;IACzD,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAKD,MAAM,UAAU,4BAA4B,CAC1C,OAAsD;IAEtD,MAAM,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IACxD,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAKD,MAAM,UAAU,6BAA6B,CAC3C,WAAmB,EACnB,cAAsB,EACtB,SAAiB;IAEjB,OAAO,sBAAsB,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;AACxE,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { AuthStrategy, AuthResult } from "@cesteral/shared";
|
|
2
|
+
export declare class MsAdsBearerAuthStrategy implements AuthStrategy {
|
|
3
|
+
private readonly customerApiBaseUrl?;
|
|
4
|
+
constructor(customerApiBaseUrl?: string | undefined);
|
|
5
|
+
verify(headers: Record<string, string | string[] | undefined>): Promise<AuthResult>;
|
|
6
|
+
getCredentialFingerprint(headers: Record<string, string | string[] | undefined>): Promise<string | undefined>;
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=msads-auth-strategy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"msads-auth-strategy.d.ts","sourceRoot":"","sources":["../../src/auth/msads-auth-strategy.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AA0BjE,qBAAa,uBAAwB,YAAW,YAAY;IAC9C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;gBAAnB,kBAAkB,CAAC,EAAE,MAAM,YAAA;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IA4BnF,wBAAwB,CAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GACrD,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAU/B"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { MsAdsAccessTokenAdapter, parseMsAdsTokenFromHeaders, getMsAdsDeveloperTokenFromHeaders, getMsAdsCustomerIdFromHeaders, getMsAdsAccountIdFromHeaders, getMsAdsCredentialFingerprint, } from "./msads-auth-adapter.js";
|
|
2
|
+
export class MsAdsBearerAuthStrategy {
|
|
3
|
+
customerApiBaseUrl;
|
|
4
|
+
constructor(customerApiBaseUrl) {
|
|
5
|
+
this.customerApiBaseUrl = customerApiBaseUrl;
|
|
6
|
+
}
|
|
7
|
+
async verify(headers) {
|
|
8
|
+
const accessToken = parseMsAdsTokenFromHeaders(headers);
|
|
9
|
+
const developerToken = getMsAdsDeveloperTokenFromHeaders(headers);
|
|
10
|
+
const customerId = getMsAdsCustomerIdFromHeaders(headers);
|
|
11
|
+
const accountId = getMsAdsAccountIdFromHeaders(headers);
|
|
12
|
+
const adapter = new MsAdsAccessTokenAdapter(accessToken, developerToken, customerId, accountId, this.customerApiBaseUrl);
|
|
13
|
+
await adapter.validate();
|
|
14
|
+
const fingerprint = getMsAdsCredentialFingerprint(accessToken, developerToken, accountId);
|
|
15
|
+
return {
|
|
16
|
+
authInfo: {
|
|
17
|
+
clientId: adapter.userId,
|
|
18
|
+
authType: "msads-bearer",
|
|
19
|
+
},
|
|
20
|
+
platformAuthAdapter: adapter,
|
|
21
|
+
credentialFingerprint: fingerprint,
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
async getCredentialFingerprint(headers) {
|
|
25
|
+
try {
|
|
26
|
+
const accessToken = parseMsAdsTokenFromHeaders(headers);
|
|
27
|
+
const developerToken = getMsAdsDeveloperTokenFromHeaders(headers);
|
|
28
|
+
const accountId = getMsAdsAccountIdFromHeaders(headers);
|
|
29
|
+
return getMsAdsCredentialFingerprint(accessToken, developerToken, accountId);
|
|
30
|
+
}
|
|
31
|
+
catch {
|
|
32
|
+
return undefined;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=msads-auth-strategy.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"msads-auth-strategy.js","sourceRoot":"","sources":["../../src/auth/msads-auth-strategy.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,uBAAuB,EACvB,0BAA0B,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,yBAAyB,CAAC;AAkBjC,MAAM,OAAO,uBAAuB;IACL;IAA7B,YAA6B,kBAA2B;QAA3B,uBAAkB,GAAlB,kBAAkB,CAAS;IAAG,CAAC;IAE5D,KAAK,CAAC,MAAM,CAAC,OAAsD;QACjE,MAAM,WAAW,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,UAAU,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,4BAA4B,CAAC,OAAO,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,IAAI,uBAAuB,CACzC,WAAW,EACX,cAAc,EACd,UAAU,EACV,SAAS,EACT,IAAI,CAAC,kBAAkB,CACxB,CAAC;QAEF,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;QAEzB,MAAM,WAAW,GAAG,6BAA6B,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QAE1F,OAAO;YACL,QAAQ,EAAE;gBACR,QAAQ,EAAE,OAAO,CAAC,MAAM;gBACxB,QAAQ,EAAE,cAAc;aACzB;YACD,mBAAmB,EAAE,OAAO;YAC5B,qBAAqB,EAAE,WAAW;SACnC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,OAAsD;QAEtD,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;YACxD,MAAM,cAAc,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;YAClE,MAAM,SAAS,GAAG,4BAA4B,CAAC,OAAO,CAAC,CAAC;YACxD,OAAO,6BAA6B,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QAC/E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;CACF"}
|