@octopusdeploy/mcp-server 0.1.2

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 (167) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +210 -0
  3. package/dist/helpers/getClientConfigurationFromEnvironment.d.ts +7 -0
  4. package/dist/helpers/getClientConfigurationFromEnvironment.d.ts.map +1 -0
  5. package/dist/helpers/getClientConfigurationFromEnvironment.js +31 -0
  6. package/dist/helpers/getClientConfigurationFromEnvironment.js.map +1 -0
  7. package/dist/helpers/getPublicUrl.d.ts +2 -0
  8. package/dist/helpers/getPublicUrl.d.ts.map +1 -0
  9. package/dist/helpers/getPublicUrl.js +4 -0
  10. package/dist/helpers/getPublicUrl.js.map +1 -0
  11. package/dist/helpers/vcsProjectHelpers.d.ts +4 -0
  12. package/dist/helpers/vcsProjectHelpers.d.ts.map +1 -0
  13. package/dist/helpers/vcsProjectHelpers.js +21 -0
  14. package/dist/helpers/vcsProjectHelpers.js.map +1 -0
  15. package/dist/index.d.ts +3 -0
  16. package/dist/index.d.ts.map +1 -0
  17. package/dist/index.js +74 -0
  18. package/dist/index.js.map +1 -0
  19. package/dist/resources/index.d.ts +3 -0
  20. package/dist/resources/index.d.ts.map +1 -0
  21. package/dist/resources/index.js +4 -0
  22. package/dist/resources/index.js.map +1 -0
  23. package/dist/resources/spacesResource.d.ts +3 -0
  24. package/dist/resources/spacesResource.d.ts.map +1 -0
  25. package/dist/resources/spacesResource.js +54 -0
  26. package/dist/resources/spacesResource.js.map +1 -0
  27. package/dist/tools/getBranches.d.ts +3 -0
  28. package/dist/tools/getBranches.d.ts.map +1 -0
  29. package/dist/tools/getBranches.js +55 -0
  30. package/dist/tools/getBranches.js.map +1 -0
  31. package/dist/tools/getCurrentUser.d.ts +3 -0
  32. package/dist/tools/getCurrentUser.d.ts.map +1 -0
  33. package/dist/tools/getCurrentUser.js +40 -0
  34. package/dist/tools/getCurrentUser.js.map +1 -0
  35. package/dist/tools/getDeploymentProcess.d.ts +3 -0
  36. package/dist/tools/getDeploymentProcess.d.ts.map +1 -0
  37. package/dist/tools/getDeploymentProcess.js +91 -0
  38. package/dist/tools/getDeploymentProcess.js.map +1 -0
  39. package/dist/tools/getDeploymentTarget.d.ts +3 -0
  40. package/dist/tools/getDeploymentTarget.d.ts.map +1 -0
  41. package/dist/tools/getDeploymentTarget.js +66 -0
  42. package/dist/tools/getDeploymentTarget.js.map +1 -0
  43. package/dist/tools/getKubernetesLiveStatus.d.ts +3 -0
  44. package/dist/tools/getKubernetesLiveStatus.d.ts.map +1 -0
  45. package/dist/tools/getKubernetesLiveStatus.js +64 -0
  46. package/dist/tools/getKubernetesLiveStatus.js.map +1 -0
  47. package/dist/tools/getLatestDeployment.d.ts +3 -0
  48. package/dist/tools/getLatestDeployment.d.ts.map +1 -0
  49. package/dist/tools/getLatestDeployment.js +85 -0
  50. package/dist/tools/getLatestDeployment.js.map +1 -0
  51. package/dist/tools/getMissingTenantVariables.d.ts +3 -0
  52. package/dist/tools/getMissingTenantVariables.d.ts.map +1 -0
  53. package/dist/tools/getMissingTenantVariables.js +47 -0
  54. package/dist/tools/getMissingTenantVariables.js.map +1 -0
  55. package/dist/tools/getReleaseById.d.ts +3 -0
  56. package/dist/tools/getReleaseById.d.ts.map +1 -0
  57. package/dist/tools/getReleaseById.js +45 -0
  58. package/dist/tools/getReleaseById.js.map +1 -0
  59. package/dist/tools/getTaskById.d.ts +9 -0
  60. package/dist/tools/getTaskById.d.ts.map +1 -0
  61. package/dist/tools/getTaskById.js +44 -0
  62. package/dist/tools/getTaskById.js.map +1 -0
  63. package/dist/tools/getTaskDetails.d.ts +9 -0
  64. package/dist/tools/getTaskDetails.d.ts.map +1 -0
  65. package/dist/tools/getTaskDetails.js +44 -0
  66. package/dist/tools/getTaskDetails.js.map +1 -0
  67. package/dist/tools/getTaskRaw.d.ts +9 -0
  68. package/dist/tools/getTaskRaw.d.ts.map +1 -0
  69. package/dist/tools/getTaskRaw.js +43 -0
  70. package/dist/tools/getTaskRaw.js.map +1 -0
  71. package/dist/tools/getTenantById.d.ts +3 -0
  72. package/dist/tools/getTenantById.d.ts.map +1 -0
  73. package/dist/tools/getTenantById.js +45 -0
  74. package/dist/tools/getTenantById.js.map +1 -0
  75. package/dist/tools/getTenantVariables.d.ts +3 -0
  76. package/dist/tools/getTenantVariables.d.ts.map +1 -0
  77. package/dist/tools/getTenantVariables.js +58 -0
  78. package/dist/tools/getTenantVariables.js.map +1 -0
  79. package/dist/tools/index.d.ts +24 -0
  80. package/dist/tools/index.d.ts.map +1 -0
  81. package/dist/tools/index.js +49 -0
  82. package/dist/tools/index.js.map +1 -0
  83. package/dist/tools/listDeploymentTargets.d.ts +3 -0
  84. package/dist/tools/listDeploymentTargets.d.ts.map +1 -0
  85. package/dist/tools/listDeploymentTargets.js +98 -0
  86. package/dist/tools/listDeploymentTargets.js.map +1 -0
  87. package/dist/tools/listDeployments.d.ts +3 -0
  88. package/dist/tools/listDeployments.d.ts.map +1 -0
  89. package/dist/tools/listDeployments.js +70 -0
  90. package/dist/tools/listDeployments.js.map +1 -0
  91. package/dist/tools/listEnvironments.d.ts +3 -0
  92. package/dist/tools/listEnvironments.d.ts.map +1 -0
  93. package/dist/tools/listEnvironments.js +42 -0
  94. package/dist/tools/listEnvironments.js.map +1 -0
  95. package/dist/tools/listProjects.d.ts +3 -0
  96. package/dist/tools/listProjects.d.ts.map +1 -0
  97. package/dist/tools/listProjects.js +44 -0
  98. package/dist/tools/listProjects.js.map +1 -0
  99. package/dist/tools/listReleases.d.ts +3 -0
  100. package/dist/tools/listReleases.d.ts.map +1 -0
  101. package/dist/tools/listReleases.js +54 -0
  102. package/dist/tools/listReleases.js.map +1 -0
  103. package/dist/tools/listReleasesForProject.d.ts +3 -0
  104. package/dist/tools/listReleasesForProject.d.ts.map +1 -0
  105. package/dist/tools/listReleasesForProject.js +60 -0
  106. package/dist/tools/listReleasesForProject.js.map +1 -0
  107. package/dist/tools/listSpaces.d.ts +3 -0
  108. package/dist/tools/listSpaces.d.ts.map +1 -0
  109. package/dist/tools/listSpaces.js +38 -0
  110. package/dist/tools/listSpaces.js.map +1 -0
  111. package/dist/tools/listTenants.d.ts +3 -0
  112. package/dist/tools/listTenants.d.ts.map +1 -0
  113. package/dist/tools/listTenants.js +64 -0
  114. package/dist/tools/listTenants.js.map +1 -0
  115. package/dist/types/baseResource.d.ts +14 -0
  116. package/dist/types/baseResource.d.ts.map +1 -0
  117. package/dist/types/baseResource.js +3 -0
  118. package/dist/types/baseResource.js.map +1 -0
  119. package/dist/types/deploymentProcessTypes.d.ts +33 -0
  120. package/dist/types/deploymentProcessTypes.d.ts.map +1 -0
  121. package/dist/types/deploymentProcessTypes.js +20 -0
  122. package/dist/types/deploymentProcessTypes.js.map +1 -0
  123. package/dist/types/deploymentTargetTypes.d.ts +74 -0
  124. package/dist/types/deploymentTargetTypes.d.ts.map +1 -0
  125. package/dist/types/deploymentTargetTypes.js +32 -0
  126. package/dist/types/deploymentTargetTypes.js.map +1 -0
  127. package/dist/types/gitBranchTypes.d.ts +11 -0
  128. package/dist/types/gitBranchTypes.d.ts.map +1 -0
  129. package/dist/types/gitBranchTypes.js +2 -0
  130. package/dist/types/gitBranchTypes.js.map +1 -0
  131. package/dist/types/projectTypes.d.ts +2 -0
  132. package/dist/types/projectTypes.d.ts.map +1 -0
  133. package/dist/types/projectTypes.js +2 -0
  134. package/dist/types/projectTypes.js.map +1 -0
  135. package/dist/types/resourceCollection.d.ts +9 -0
  136. package/dist/types/resourceCollection.d.ts.map +1 -0
  137. package/dist/types/resourceCollection.js +2 -0
  138. package/dist/types/resourceCollection.js.map +1 -0
  139. package/dist/types/spaceTypes.d.ts +2 -0
  140. package/dist/types/spaceTypes.d.ts.map +1 -0
  141. package/dist/types/spaceTypes.js +2 -0
  142. package/dist/types/spaceTypes.js.map +1 -0
  143. package/dist/types/taskTypes.d.ts +2 -0
  144. package/dist/types/taskTypes.d.ts.map +1 -0
  145. package/dist/types/taskTypes.js +2 -0
  146. package/dist/types/taskTypes.js.map +1 -0
  147. package/dist/types/tenantsTypes.d.ts +2 -0
  148. package/dist/types/tenantsTypes.d.ts.map +1 -0
  149. package/dist/types/tenantsTypes.js +2 -0
  150. package/dist/types/tenantsTypes.js.map +1 -0
  151. package/dist/types/toolConfig.d.ts +19 -0
  152. package/dist/types/toolConfig.d.ts.map +1 -0
  153. package/dist/types/toolConfig.js +17 -0
  154. package/dist/types/toolConfig.js.map +1 -0
  155. package/dist/utils/clientInfo.d.ts +20 -0
  156. package/dist/utils/clientInfo.d.ts.map +1 -0
  157. package/dist/utils/clientInfo.js +23 -0
  158. package/dist/utils/clientInfo.js.map +1 -0
  159. package/dist/utils/logger.d.ts +45 -0
  160. package/dist/utils/logger.d.ts.map +1 -0
  161. package/dist/utils/logger.js +130 -0
  162. package/dist/utils/logger.js.map +1 -0
  163. package/dist/utils/parseConfig.d.ts +4 -0
  164. package/dist/utils/parseConfig.d.ts.map +1 -0
  165. package/dist/utils/parseConfig.js +21 -0
  166. package/dist/utils/parseConfig.js.map +1 -0
  167. package/package.json +50 -0
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md ADDED
@@ -0,0 +1,210 @@
1
+ # 🐙 Octopus Deploy Official MCP Server (Early Access)
2
+
3
+ [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) allows the AI assistants you use in your day to day work, like Claude Code, or ChatGPT, to connect to the systems and services you own in a standardized fashion, allowing them to pull information from those systems and services to answer questions and perform tasks.
4
+
5
+ The Octopus MCP Server provides your AI assistant with powerful tools that allow it to inspect, query, and diagnose problems within your Octopus instance, transforming it into your ultimate DevOps wingmate.
6
+
7
+ This project is currently in Early Access, and subject to breaking changes.
8
+
9
+ ### Octopus Server Compatibility
10
+
11
+ TODO: Make stronger guarantees about the version of server this will work against.
12
+
13
+ The MCP Server is developed and tested against versions `2025.3.x` of Octopus Server. Most of the APIs used are stable and exist in prior versions of Octopus and should therefore be generally compatible, but we will not be testing or deliberately maintaining compatibility with older versions of Octopus.
14
+
15
+ ## 🚀 Installation
16
+
17
+ ### Requirements
18
+ - Node.js >= v20.0.0
19
+ - Octopus Deploy instance that can be accessed by the MCP server via HTTPS
20
+ - Octopus Deploy API Key
21
+
22
+ ### Configuration
23
+
24
+ Full example configuration (for Claude Desktop, Claude Code, and Cursor):
25
+ ```json
26
+ {
27
+ "mcpServers": {
28
+ "octopusdeploy": {
29
+ "command": "npx",
30
+ "args": ["-y", "@octopusdeploy/mcp-server", "--api-key", "YOUR_API_KEY", "--server-url", "https://your-octopus.com"]
31
+ }
32
+ }
33
+ }
34
+ ```
35
+
36
+ The Octopus MCP Server is typically configured within your AI Client of choice.
37
+
38
+ It is packaged as an npm package and executed via Node's `npx` command. Your configuration will include the command invocation `npx`, and a set of arguments that supply the Octoups MCP Server package and provide the Octopus Server URL and API key required, if they are not available as environment variables.
39
+
40
+ The command line invocation you will be configuring will be one of the two following variants:
41
+
42
+ ```bash
43
+ npx -y @octopusdeploy/mcp-server
44
+ ```
45
+
46
+ With configuration provided via environment variables:
47
+ ```bash
48
+ OCTOPUS_API_KEY=API-KEY
49
+ OCTOPUS_SERVER_URL=https://your-octopus.com
50
+ ```
51
+
52
+ Or with configuration supplied via the command line:
53
+ ```bash
54
+ npx -y @octopusdeploy/mcp-server --server-url https://your-octopus.com --api-key YOUR_API_KEY
55
+ ```
56
+
57
+ ### Configuration Options
58
+
59
+ The Octopus MCP Server supports several command-line options to customize which tools are available.
60
+
61
+ If you are not sure which tools you require, we recommend running without any additional command-line options and using the provided defaults.
62
+
63
+ #### Toolsets
64
+ Use the `--toolsets` parameter to enable specific groups of tools:
65
+
66
+ ```bash
67
+ # Enable all toolsets (default)
68
+ npx -y @octopusdeploy/mcp-server
69
+
70
+ # Enable only specific toolsets
71
+ npx -y @octopusdeploy/mcp-server --toolsets projects,deployments
72
+
73
+ # Enable all toolsets explicitly
74
+ npx -y @octopusdeploy/mcp-server --toolsets all
75
+ ```
76
+
77
+ Available toolsets:
78
+ - **core** - Basic operations (always enabled)
79
+ - **projects** - Project operations
80
+ - **deployments** - Deployment operations
81
+ - **releases** - Release management
82
+ - **tasks** - Task operations
83
+ - **tenants** - Multi-tenancy operations
84
+ - **kubernetes** - Kubernetes operations
85
+ - **machines** - Deployment target operations
86
+
87
+ #### Read-Only Mode
88
+ The server runs in read-only mode by default for security. All current tools are read-only operations.
89
+
90
+ ```bash
91
+ # Run in read-only mode (default)
92
+ npx -y @octopusdeploy/mcp-server --read-only
93
+
94
+ # Disable read-only mode (currently no effect as all tools are read-only)
95
+ npx -y @octopusdeploy/mcp-server --read-only=false
96
+ ```
97
+
98
+ #### Complete Examples
99
+
100
+ ```bash
101
+ # Development setup with only core and project tools
102
+ npx -y @octopusdeploy/mcp-server --toolsets core,projects --server-url https://your-octopus.com --api-key YOUR_API_KEY
103
+
104
+ # Full production setup with all tools
105
+ npx -y @octopusdeploy/mcp-server --toolsets all --read-only --server-url https://your-octopus.com --api-key YOUR_API_KEY
106
+ ```
107
+
108
+ ### Running from Github Registry (TODO: Remove)
109
+
110
+ This is a temporary workaround until we start publishing preview versions to the public npm registry. The following is assuming you are already signed in to the github registry.
111
+
112
+ 1. In a new folder install dependencies manually:
113
+ ```bash
114
+ npm install @octopusdeploy/api-client @modelcontextprotocol/sdk commander dotenv zod
115
+ ```
116
+
117
+ 2. Create `.npmrc` file with the following contents:
118
+ ```bash
119
+ @octopusdeploy:registry=https://npm.pkg.github.com
120
+ ```
121
+
122
+ 3. Install the mcp-server:
123
+ ```bash
124
+ npm install @octopusdeploy/mcp-server
125
+ ```
126
+
127
+ 4. Run it via:
128
+ ```bash
129
+ npx "your/folders/full/path" -y @octopusdeploy/mcp-server
130
+ ```
131
+
132
+ ## 🔨 Tools
133
+
134
+ ### Core Tools
135
+ - `list_spaces`: List all spaces in the Octopus Deploy instance
136
+ - `list_environments`: List all environments in a given space
137
+
138
+ ### Projects
139
+ - `list_projects`: List all projects in a given space
140
+
141
+ ### Deployments
142
+ - `list_deployments`: List deployments in a space with optional filtering
143
+
144
+ ### Releases
145
+ - `get_release_by_id`: Get details for a specific release by its ID
146
+ - `list_releases`: List all releases in a given space
147
+ - `list_releases_for_project`: List all releases for a specific project
148
+
149
+ ### Tasks
150
+ - `get_task_by_id`: Get details for a specific server task by its ID
151
+ - `get_task_details`: Get detailed information for a specific server task
152
+ - `get_task_raw`: Get raw details for a specific server task
153
+
154
+ ### Tenants
155
+ - `list_tenants`: List all tenants in a given space
156
+ - `get_tenant_by_id`: Get details for a specific tenant by its ID
157
+ - `get_tenant_variables`: Get tenant variables by type (all, common, or project)
158
+ - `get_missing_tenant_variables`: Get tenant variables that are missing values
159
+
160
+ ### Kubernetes
161
+ - `get_kubernetes_live_status`: Get live status of Kubernetes resources for a project and environment (only supported in Octopus Server starting with version `2025.3`)
162
+
163
+ ### Machines (Deployment Targets)
164
+ - `list_deployment_targets`: List all deployment targets in a space with optional filtering
165
+ - `get_deployment_target`: Get detailed information about a specific deployment target
166
+
167
+ ### Additional Tools
168
+ - `get_deployment_process`: Get deployment process by ID for projects or releases
169
+ - `get_branches`: Get Git branches for a version-controlled project
170
+ - `get_current_user`: Get information about the current authenticated user
171
+
172
+ ## Security Considerations
173
+
174
+ While the Octopus MCP Server at this stage is a read-only tool, it **can read full deployment logs, which could include production secrets.** Exercise caution when connecting Octopus MCP to tools and models you do not fully trust.
175
+
176
+ Running agents in a fully automated fashion could make you vulnerable to exposure via prompt-injection attacks that exfiltrate tokens.
177
+
178
+ Exercise caution and mitigate the risks by using least-privileged accounts when connecting to Octopus Server.
179
+
180
+ ## Limitations
181
+
182
+ ### Data Analysis
183
+
184
+ The nature of current AI chat tools and the MCP protocol itself makes it impractical to analyze large amounts of data. Most MCP clients currently do not support chaining tool calls (using the output of one tool as input to the next one) and instead fall back to copying the results token by token, which frequently leads to hallucinations. If you are looking to process historical data from your Octopus instance for analysis purposes, we recommend using the API directly or writing your own MCP client that is capable of processing the tool call results programmatically.
185
+
186
+ ### Performance
187
+
188
+ The MCP Server is technically just a thin layer on top of the existing Octopus Server API. As such it is capable of retrieving large amounts of data (for example, requesting thousands of deployments). Such queries can have a significant effect on your instance's performance. Instruct your models to only retrieve the minimum set of data that it needs (most models are really good at this out of the box).
189
+
190
+ ## Contributing
191
+
192
+ We are eager to hear how you plan to use Octopus MCP Server and what features you would like to see included in future version.
193
+
194
+ Please use [Issues](https://github.com/OctopusDeploy/mcp-server/issues) to provide feedback, or request features.
195
+
196
+ If you are a current Octopus customer, please report any issues you experience using our MCP server to our [support team](mailto:support@octoups.com). This will ensure you get a timely response within our standard support guarantees.
197
+
198
+ ## FAQ
199
+
200
+ ### Do you have plans to release a remote MCP server?
201
+
202
+ We are working on integrating an MCP server directly into Octopus Server. This will open up the door for us to build more complex MCP tools, as well as:
203
+
204
+ * Giving Octopus Administrators more granular control over MCP clients
205
+ * Natively support OAuth for client authentication
206
+ * Integrating security scanning tools into the MCP output
207
+
208
+ ## License
209
+
210
+ This project is licensed under the terms of Mozilla Public License 2.0 open source license.
@@ -0,0 +1,7 @@
1
+ import { type ClientConfiguration } from "@octopusdeploy/api-client";
2
+ export interface ConfigurationOptions {
3
+ instanceURL?: string;
4
+ apiKey?: string;
5
+ }
6
+ export declare function getClientConfigurationFromEnvironment(): ClientConfiguration;
7
+ //# sourceMappingURL=getClientConfigurationFromEnvironment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getClientConfigurationFromEnvironment.d.ts","sourceRoot":"","sources":["../../src/helpers/getClientConfigurationFromEnvironment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAOrE,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA6BD,wBAAgB,qCAAqC,IAAI,mBAAmB,CAK3E"}
@@ -0,0 +1,31 @@
1
+ import {} from "@octopusdeploy/api-client";
2
+ import { env } from "process";
3
+ import { SEMVER_VERSION } from "../index.js";
4
+ import { getClientInfo } from "../utils/clientInfo.js";
5
+ const USER_AGENT_NAME = "octopus-mcp-server";
6
+ function isEmpty(value) {
7
+ return !value || value.trim().length === 0;
8
+ }
9
+ function constructUserAgent(options) {
10
+ const clientInfo = getClientInfo();
11
+ const userAgent = `${USER_AGENT_NAME}/${SEMVER_VERSION} (${clientInfo.name}/${clientInfo.version})`;
12
+ return userAgent;
13
+ }
14
+ function getClientConfiguration(options = {}) {
15
+ if (isEmpty(options.instanceURL) || isEmpty(options.apiKey)) {
16
+ throw new Error("Octopus server URL and API key must be provided either via command line arguments (--server-url, --api-key) or environment variables (OCTOPUS_SERVER_URL, OCTOPUS_API_KEY).");
17
+ }
18
+ const userAgent = constructUserAgent(options);
19
+ return {
20
+ userAgentApp: userAgent,
21
+ instanceURL: options.instanceURL,
22
+ apiKey: options.apiKey,
23
+ };
24
+ }
25
+ export function getClientConfigurationFromEnvironment() {
26
+ return getClientConfiguration({
27
+ instanceURL: env["CLI_SERVER_URL"] || env["OCTOPUS_SERVER_URL"],
28
+ apiKey: env["CLI_API_KEY"] || env["OCTOPUS_API_KEY"],
29
+ });
30
+ }
31
+ //# sourceMappingURL=getClientConfigurationFromEnvironment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getClientConfigurationFromEnvironment.js","sourceRoot":"","sources":["../../src/helpers/getClientConfigurationFromEnvironment.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAO7C,SAAS,OAAO,CAAC,KAAyB;IACxC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,kBAAkB,CAAC,OAA6B;IACvD,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;IACnC,MAAM,SAAS,GAAG,GAAG,eAAe,IAAI,cAAc,KAAK,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,OAAO,GAAG,CAAC;IAEpG,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,sBAAsB,CAAC,UAAgC,EAAE;IAChE,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE9C,OAAO;QACL,YAAY,EAAE,SAAS;QACvB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qCAAqC;IACnD,OAAO,sBAAsB,CAAC;QAC5B,WAAW,EAAE,GAAG,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,oBAAoB,CAAC;QAC/D,MAAM,EAAE,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,iBAAiB,CAAC;KACrD,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,2 @@
1
+ export declare function getPublicUrl(template: string, parameters: Record<string, string>): string;
2
+ //# sourceMappingURL=getPublicUrl.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getPublicUrl.d.ts","sourceRoot":"","sources":["../../src/helpers/getPublicUrl.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,UAEhF"}
@@ -0,0 +1,4 @@
1
+ export function getPublicUrl(template, parameters) {
2
+ return template.replace(/{(\w+)}/g, (_, key) => parameters[key] || `{${key}}`);
3
+ }
4
+ //# sourceMappingURL=getPublicUrl.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getPublicUrl.js","sourceRoot":"","sources":["../../src/helpers/getPublicUrl.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY,CAAC,QAAgB,EAAE,UAAkC;IAC/E,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,GAAG,CAAC,CAAC;AACjF,CAAC"}
@@ -0,0 +1,4 @@
1
+ import { type Client, type ResourceCollection } from "@octopusdeploy/api-client";
2
+ import { type GitBranch, type GetProjectBranchesOptions } from "../types/gitBranchTypes.js";
3
+ export declare function getProjectBranches(client: Client, spaceId: string, projectId: string, options?: GetProjectBranchesOptions): Promise<ResourceCollection<GitBranch>>;
4
+ //# sourceMappingURL=vcsProjectHelpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"vcsProjectHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/vcsProjectHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAE5F,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAyBxC"}