@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/README.md +3 -0
  2. package/dist/bundle.js +106 -12
  3. package/dist/register.js +7 -0
  4. package/dist/register.js.map +1 -1
  5. package/dist/tools/powershell/documentation/add-basetemplate.md +137 -0
  6. package/dist/tools/powershell/documentation/add-itemacl.md +254 -0
  7. package/dist/tools/powershell/documentation/add-itemversion.md +231 -0
  8. package/dist/tools/powershell/documentation/add-placeholdersetting.md +410 -0
  9. package/dist/tools/powershell/documentation/add-rendering.md +217 -0
  10. package/dist/tools/powershell/documentation/add-rolemember.md +88 -0
  11. package/dist/tools/powershell/documentation/clear-itemacl.md +131 -0
  12. package/dist/tools/powershell/documentation/close-window.md +32 -0
  13. package/dist/tools/powershell/documentation/commands-list.md +134 -0
  14. package/dist/tools/powershell/documentation/convertfrom-clixml.md +67 -0
  15. package/dist/tools/powershell/documentation/convertfrom-itemclone.md +118 -0
  16. package/dist/tools/powershell/documentation/convertto-clixml.md +66 -0
  17. package/dist/tools/powershell/documentation/disable-user.md +89 -0
  18. package/dist/tools/powershell/documentation/enable-user.md +89 -0
  19. package/dist/tools/powershell/documentation/expand-token.md +144 -0
  20. package/dist/tools/powershell/documentation/export-item.md +165 -0
  21. package/dist/tools/powershell/documentation/export-package.md +129 -0
  22. package/dist/tools/powershell/documentation/export-role.md +150 -0
  23. package/dist/tools/powershell/documentation/export-updatepackage.md +111 -0
  24. package/dist/tools/powershell/documentation/export-user.md +147 -0
  25. package/dist/tools/powershell/documentation/find-item.md +718 -0
  26. package/dist/tools/powershell/documentation/get-archive.md +73 -0
  27. package/dist/tools/powershell/documentation/get-archiveitem.md +138 -0
  28. package/dist/tools/powershell/documentation/get-cache.md +62 -0
  29. package/dist/tools/powershell/documentation/get-database.md +96 -0
  30. package/dist/tools/powershell/documentation/get-domain.md +75 -0
  31. package/dist/tools/powershell/documentation/get-item.md +186 -0
  32. package/dist/tools/powershell/documentation/get-itemacl.md +168 -0
  33. package/dist/tools/powershell/documentation/get-itemclone.md +100 -0
  34. package/dist/tools/powershell/documentation/get-itemclonenotification.md +95 -0
  35. package/dist/tools/powershell/documentation/get-itemfield.md +182 -0
  36. package/dist/tools/powershell/documentation/get-itemreference.md +152 -0
  37. package/dist/tools/powershell/documentation/get-itemreferrer.md +154 -0
  38. package/dist/tools/powershell/documentation/get-itemtemplate.md +152 -0
  39. package/dist/tools/powershell/documentation/get-itemworkflowevent.md +133 -0
  40. package/dist/tools/powershell/documentation/get-layout.md +142 -0
  41. package/dist/tools/powershell/documentation/get-layoutdevice.md +97 -0
  42. package/dist/tools/powershell/documentation/get-package.md +63 -0
  43. package/dist/tools/powershell/documentation/get-placeholdersetting.md +477 -0
  44. package/dist/tools/powershell/documentation/get-preset.md +70 -0
  45. package/dist/tools/powershell/documentation/get-rendering.md +248 -0
  46. package/dist/tools/powershell/documentation/get-renderingparameter.md +84 -0
  47. package/dist/tools/powershell/documentation/get-role.md +134 -0
  48. package/dist/tools/powershell/documentation/get-rolemember.md +131 -0
  49. package/dist/tools/powershell/documentation/get-scriptsession.md +128 -0
  50. package/dist/tools/powershell/documentation/get-searchindex.md +92 -0
  51. package/dist/tools/powershell/documentation/get-session.md +107 -0
  52. package/dist/tools/powershell/documentation/get-sitecorejob.md +102 -0
  53. package/dist/tools/powershell/documentation/get-spemodule.md +134 -0
  54. package/dist/tools/powershell/documentation/get-spemodulefeatureroot.md +113 -0
  55. package/dist/tools/powershell/documentation/get-taskschedule.md +136 -0
  56. package/dist/tools/powershell/documentation/get-updatepackagediff.md +110 -0
  57. package/dist/tools/powershell/documentation/get-user.md +193 -0
  58. package/dist/tools/powershell/documentation/get-useragent.md +38 -0
  59. package/dist/tools/powershell/documentation/import-function.md +83 -0
  60. package/dist/tools/powershell/documentation/import-item-1.md +180 -0
  61. package/dist/tools/powershell/documentation/import-item.md +180 -0
  62. package/dist/tools/powershell/documentation/import-role.md +137 -0
  63. package/dist/tools/powershell/documentation/import-user.md +137 -0
  64. package/dist/tools/powershell/documentation/initialize-item.md +87 -0
  65. package/dist/tools/powershell/documentation/initialize-searchindex.md +116 -0
  66. package/dist/tools/powershell/documentation/initialize-searchindexitem.md +85 -0
  67. package/dist/tools/powershell/documentation/install-package.md +95 -0
  68. package/dist/tools/powershell/documentation/install-updatepackage.md +90 -0
  69. package/dist/tools/powershell/documentation/invoke-javascript.md +22 -0
  70. package/dist/tools/powershell/documentation/invoke-script.md +111 -0
  71. package/dist/tools/powershell/documentation/invoke-shellcommand.md +144 -0
  72. package/dist/tools/powershell/documentation/invoke-workflow.md +142 -0
  73. package/dist/tools/powershell/documentation/lock-item.md +157 -0
  74. package/dist/tools/powershell/documentation/login-user.md +56 -0
  75. package/dist/tools/powershell/documentation/logout-user.md +30 -0
  76. package/dist/tools/powershell/documentation/merge-layout.md +102 -0
  77. package/dist/tools/powershell/documentation/new-domain.md +72 -0
  78. package/dist/tools/powershell/documentation/new-explicitfilesource.md +104 -0
  79. package/dist/tools/powershell/documentation/new-explicititemsource.md +146 -0
  80. package/dist/tools/powershell/documentation/new-filesource.md +128 -0
  81. package/dist/tools/powershell/documentation/new-itemacl.md +175 -0
  82. package/dist/tools/powershell/documentation/new-itemclone.md +139 -0
  83. package/dist/tools/powershell/documentation/new-itemsource.md +171 -0
  84. package/dist/tools/powershell/documentation/new-itemworkflowevent.md +140 -0
  85. package/dist/tools/powershell/documentation/new-package.md +81 -0
  86. package/dist/tools/powershell/documentation/new-placeholdersetting.md +255 -0
  87. package/dist/tools/powershell/documentation/new-rendering.md +243 -0
  88. package/dist/tools/powershell/documentation/new-role.md +56 -0
  89. package/dist/tools/powershell/documentation/new-securitysource.md +176 -0
  90. package/dist/tools/powershell/documentation/new-user.md +161 -0
  91. package/dist/tools/powershell/documentation/new-usingblock.md +95 -0
  92. package/dist/tools/powershell/documentation/out-download.md +123 -0
  93. package/dist/tools/powershell/documentation/protect-item.md +120 -0
  94. package/dist/tools/powershell/documentation/publish-item.md +224 -0
  95. package/dist/tools/powershell/documentation/read-variable.md +252 -0
  96. package/dist/tools/powershell/documentation/receive-file.md +244 -0
  97. package/dist/tools/powershell/documentation/receive-itemclonenotification.md +116 -0
  98. package/dist/tools/powershell/documentation/receive-scriptsession.md +108 -0
  99. package/dist/tools/powershell/documentation/remove-archiveitem.md +125 -0
  100. package/dist/tools/powershell/documentation/remove-basetemplate.md +137 -0
  101. package/dist/tools/powershell/documentation/remove-domain.md +70 -0
  102. package/dist/tools/powershell/documentation/remove-itemversion.md +209 -0
  103. package/dist/tools/powershell/documentation/remove-layout.md +151 -0
  104. package/dist/tools/powershell/documentation/remove-placeholdersetting.md +478 -0
  105. package/dist/tools/powershell/documentation/remove-rendering.md +253 -0
  106. package/dist/tools/powershell/documentation/remove-renderingparameter.md +83 -0
  107. package/dist/tools/powershell/documentation/remove-role.md +70 -0
  108. package/dist/tools/powershell/documentation/remove-rolemember.md +79 -0
  109. package/dist/tools/powershell/documentation/remove-scriptsession.md +72 -0
  110. package/dist/tools/powershell/documentation/remove-searchindexitem.md +79 -0
  111. package/dist/tools/powershell/documentation/remove-session.md +77 -0
  112. package/dist/tools/powershell/documentation/remove-user.md +97 -0
  113. package/dist/tools/powershell/documentation/reset-itemfield.md +149 -0
  114. package/dist/tools/powershell/documentation/reset-layout.md +130 -0
  115. package/dist/tools/powershell/documentation/restart-application.md +30 -0
  116. package/dist/tools/powershell/documentation/restore-archiveitem.md +126 -0
  117. package/dist/tools/powershell/documentation/resume-searchindex.md +84 -0
  118. package/dist/tools/powershell/documentation/send-file.md +160 -0
  119. package/dist/tools/powershell/documentation/send-sheermessage.md +66 -0
  120. package/dist/tools/powershell/documentation/set-hostproperty.md +90 -0
  121. package/dist/tools/powershell/documentation/set-itemacl.md +158 -0
  122. package/dist/tools/powershell/documentation/set-itemtemplate.md +156 -0
  123. package/dist/tools/powershell/documentation/set-layout.md +166 -0
  124. package/dist/tools/powershell/documentation/set-rendering.md +213 -0
  125. package/dist/tools/powershell/documentation/set-renderingparameter.md +97 -0
  126. package/dist/tools/powershell/documentation/set-user.md +221 -0
  127. package/dist/tools/powershell/documentation/set-userpassword.md +109 -0
  128. package/dist/tools/powershell/documentation/show-alert.md +53 -0
  129. package/dist/tools/powershell/documentation/show-application.md +150 -0
  130. package/dist/tools/powershell/documentation/show-confirm.md +61 -0
  131. package/dist/tools/powershell/documentation/show-fieldeditor.md +231 -0
  132. package/dist/tools/powershell/documentation/show-input.md +129 -0
  133. package/dist/tools/powershell/documentation/show-listview.md +276 -0
  134. package/dist/tools/powershell/documentation/show-modaldialog.md +137 -0
  135. package/dist/tools/powershell/documentation/show-result.md +158 -0
  136. package/dist/tools/powershell/documentation/show-yesnocancel.md +92 -0
  137. package/dist/tools/powershell/documentation/start-scriptsession.md +230 -0
  138. package/dist/tools/powershell/documentation/start-taskschedule.md +124 -0
  139. package/dist/tools/powershell/documentation/stop-scriptsession.md +78 -0
  140. package/dist/tools/powershell/documentation/stop-searchindex.md +84 -0
  141. package/dist/tools/powershell/documentation/suspend-searchindex.md +84 -0
  142. package/dist/tools/powershell/documentation/switch-rendering.md +248 -0
  143. package/dist/tools/powershell/documentation/test-account.md +74 -0
  144. package/dist/tools/powershell/documentation/test-basetemplate.md +97 -0
  145. package/dist/tools/powershell/documentation/test-itemacl.md +182 -0
  146. package/dist/tools/powershell/documentation/test-rule.md +111 -0
  147. package/dist/tools/powershell/documentation/unlock-item.md +124 -0
  148. package/dist/tools/powershell/documentation/unlock-user.md +84 -0
  149. package/dist/tools/powershell/documentation/unprotect-item.md +124 -0
  150. package/dist/tools/powershell/documentation/update-itemreferrer.md +234 -0
  151. package/dist/tools/powershell/documentation/update-listview.md +139 -0
  152. package/dist/tools/powershell/documentation/update-searchindexitem.md +79 -0
  153. package/dist/tools/powershell/documentation/wait-scriptsession.md +100 -0
  154. package/dist/tools/powershell/documentation/write-log.md +82 -0
  155. package/dist/tools/powershell/get-powershell-documentation.d.ts +2 -0
  156. package/dist/tools/powershell/get-powershell-documentation.js +47 -0
  157. package/dist/tools/powershell/get-powershell-documentation.js.map +1 -0
  158. package/dist/tools/powershell/run-powershell-script.d.ts +3 -0
  159. package/dist/tools/powershell/run-powershell-script.js +13 -0
  160. package/dist/tools/powershell/run-powershell-script.js.map +1 -0
  161. package/dist/tools/sitecore-cli/get-sitecore-cli-documentation.d.ts +3 -0
  162. package/dist/tools/sitecore-cli/get-sitecore-cli-documentation.js +24 -0
  163. package/dist/tools/sitecore-cli/get-sitecore-cli-documentation.js.map +1 -0
  164. package/dist/tools/sitecore-cli/sitecore-cli-documentation.md +70 -0
  165. package/package.json +8 -8
@@ -0,0 +1,139 @@
1
+ # Update-ListView
2
+
3
+ Updates List View \(created by Show-ListView\) data.
4
+
5
+ ## Syntax
6
+
7
+ Update-ListView \[-InfoTitle <String>\] \[-InfoDescription <String>\] \[-MissingDataMessage <String>\] \[-Icon <String>\] -Data <Object> \[-Property <Object\[\]>\]
8
+
9
+ ## Detailed Description
10
+
11
+ This command updates the data displayed by List View that called the script the command is part of. Calling this command makes sense only when it's being used in script exposed as Action on the Show-ListView window. For example the main script might be listing all logged in users. And than the "Kick" action might be closing sessions for selected rows and refreshing the List view to take into account that the sessions are no longer connected. Another example is Task Manager script you can find in Toolbox. The List View shown by it shows tasks and when they were last run. If you choose to execute a task the Update-ListView command will later be called to update the data to account for the fact that the task's "Last Run" date has been updated.
12
+
13
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
14
+
15
+ ## Parameters
16
+
17
+ ### -InfoTitle <String>
18
+
19
+ | Aliases | |
20
+ | :--- | :--- |
21
+ | Required? | false |
22
+ | Position? | named |
23
+ | Default Value | |
24
+ | Accept Pipeline Input? | false |
25
+ | Accept Wildcard Characters? | false |
26
+
27
+ ### -InfoDescription <String>
28
+
29
+ | Aliases | |
30
+ | :--- | :--- |
31
+ | Required? | false |
32
+ | Position? | named |
33
+ | Default Value | |
34
+ | Accept Pipeline Input? | false |
35
+ | Accept Wildcard Characters? | false |
36
+
37
+ ### -MissingDataMessage <String>
38
+
39
+ | Aliases | |
40
+ | :--- | :--- |
41
+ | Required? | false |
42
+ | Position? | named |
43
+ | Default Value | |
44
+ | Accept Pipeline Input? | false |
45
+ | Accept Wildcard Characters? | false |
46
+
47
+ ### -Icon <String>
48
+
49
+ | Aliases | |
50
+ | :--- | :--- |
51
+ | Required? | false |
52
+ | Position? | named |
53
+ | Default Value | |
54
+ | Accept Pipeline Input? | false |
55
+ | Accept Wildcard Characters? | false |
56
+
57
+ ### -Data <Object>
58
+
59
+ Data that you want to be sent to the list view for display.
60
+
61
+ | Aliases | |
62
+ | :--- | :--- |
63
+ | Required? | true |
64
+ | Position? | named |
65
+ | Default Value | |
66
+ | Accept Pipeline Input? | true \(ByValue\) |
67
+ | Accept Wildcard Characters? | false |
68
+
69
+ ### -Property <Object\[\]>
70
+
71
+ If this parameter is specified - it allows for modifying the columns shown in the list view, otherwise the columns stay the same as in the original view.
72
+
73
+ | Aliases | |
74
+ | :--- | :--- |
75
+ | Required? | false |
76
+ | Position? | named |
77
+ | Default Value | |
78
+ | Accept Pipeline Input? | false |
79
+ | Accept Wildcard Characters? | false |
80
+
81
+ ## Inputs
82
+
83
+ The input type is the type of the objects that you can pipe to the cmdlet.
84
+
85
+ * Sitecore.Data.Items.Item
86
+
87
+ ## Outputs
88
+
89
+ The output type is the type of the objects that the cmdlet emits.
90
+
91
+ * System.String
92
+
93
+ ## Notes
94
+
95
+ Help Author: Adam Najmanowicz, Michael West
96
+
97
+ ## Examples
98
+
99
+ ### EXAMPLE
100
+
101
+ This example consists of 2 scripts - a report that shows a list view and the second one that updates the list view from an action.
102
+
103
+ ```powershell
104
+ # THE INITIAL SCRIPT showing the list of tasks in a list view
105
+ # This script does not yet make use of Update-ListView but tests the state for actions to be performed
106
+
107
+ Import-Function "Edit-TaskSchedule"
108
+
109
+ # Get all the items recursively where the TemplateName equals "Schedule".
110
+ Get-ChildItem -Path master:\system\Tasks\Schedules -Recurse | Where-Object { $_.TemplateName -eq "Schedule" } |
111
+ Show-ListView -Property @{Label="Name"; Expression={ $_.DisplayName } },
112
+ @{Label="Last Run"; Expression={ $_."Last Run" } },
113
+ @{Label="Command"; Expression={ $_.Database.GetItem($_.Command).Name } },
114
+ @{Label="From"; Expression={ Parse-TaskSchedule $_ "from"} },
115
+ @{Label="To"; Expression={ Parse-TaskSchedule $_ "to"} },
116
+ @{Label="On Week Days"; Expression={ Parse-TaskSchedule $_ "strWeekdays" } },
117
+ @{Label="Run Every"; Expression={ Parse-TaskSchedule $_ "interval" } } `
118
+ -Title "Task Manager"
119
+ Close-Window
120
+
121
+
122
+
123
+ # NOW THE PROPER ACTION SCRIPT
124
+
125
+ # The Execute task action that (at the very end) updates the list with the latest tasks data
126
+ foreach($sheduleItem in $resultSet)
127
+ {
128
+ $shedule = New-Object -TypeName "Sitecore.Tasks.ScheduleItem" -ArgumentList $sheduleItem
129
+ $shedule.Execute();
130
+ }
131
+ Import-Function "Edit-TaskSchedule"
132
+ Get-ChildItem -Path master:\system\Tasks\Schedules -Recurse | Where-Object { $_.TemplateName -eq "Schedule" } | Update-ListView
133
+ ```
134
+
135
+ ## Related Topics
136
+
137
+ * [Show-ListView](show-listview.md)
138
+ * [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/)
139
+
@@ -0,0 +1,79 @@
1
+ # Update-SearchIndexItem
2
+
3
+ ## Syntax
4
+
5
+ ```powershell
6
+ Update-SearchIndexItem -Item <Item> [-Name <String>] [-AsJob]
7
+ Update-SearchIndexItem -Item <Item> [-Name <String>] [-AsJob]
8
+ Update-SearchIndexItem -SearchResultItem <SearchResultItem> [-AsJob]
9
+ ```
10
+
11
+ ## Detailed Description
12
+
13
+ Updates an item in the specified index. Supports wildcard filtering for the index name.
14
+
15
+ © 2010-2020 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
16
+
17
+ ## Parameters
18
+
19
+ ### -Item  &lt;Item&gt;
20
+
21
+ | Aliases | |
22
+ | :--- | :--- |
23
+ | Required? | true |
24
+ | Position? | named |
25
+ | Default Value | |
26
+ | Accept Pipeline Input? | true \(ByValue\) |
27
+ | Accept Wildcard Characters? | false |
28
+
29
+ ### -SearchResultItem  &lt;SearchResultItem&gt;
30
+
31
+ | Aliases | |
32
+ | :--- | :--- |
33
+ | Required? | true |
34
+ | Position? | named |
35
+ | Default Value | |
36
+ | Accept Pipeline Input? | true \(ByValue\) |
37
+ | Accept Wildcard Characters? | false |
38
+
39
+ ### -AsJob  &lt;SwitchParameter&gt;
40
+
41
+ | Aliases | |
42
+ | :--- | :--- |
43
+ | Required? | false |
44
+ | Position? | named |
45
+ | Default Value | |
46
+ | Accept Pipeline Input? | false |
47
+ | Accept Wildcard Characters? | false |
48
+
49
+ ### -Name  &lt;String&gt;
50
+
51
+ | Aliases | |
52
+ | :--- | :--- |
53
+ | Required? | false |
54
+ | Position? | named |
55
+ | Default Value | |
56
+ | Accept Pipeline Input? | false |
57
+ | Accept Wildcard Characters? | false |
58
+
59
+ ## Examples
60
+
61
+ ### EXAMPLE 1
62
+
63
+ The following updates the index for a given item and index name.
64
+
65
+ ```powershell
66
+ $item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
67
+ $indexName = "sitecore_master_index"
68
+ Update-SearchIndexItem -Item $item -Name $indexName
69
+ ```
70
+
71
+ ### EXAMPLE 2
72
+
73
+ The following updates the indexed item for the indexes matching the wildcard pattern.
74
+
75
+ ```powershell
76
+ $item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
77
+ $indexName = "sitecore_*_index"
78
+ Update-SearchIndexItem -Item $item -Name $indexName
79
+ ```
@@ -0,0 +1,100 @@
1
+ # Wait-ScriptSession
2
+
3
+ Suppresses script execution command prompt until one or all of the script sessions provided are complete.
4
+
5
+ ## Syntax
6
+
7
+ Wait-ScriptSession -Id &lt;String\[\]&gt; \[-Timeout &lt;Int32&gt;\] \[-Any\]
8
+
9
+ Wait-ScriptSession -Session &lt;ScriptSession\[\]&gt; \[-Timeout &lt;Int32&gt;\] \[-Any\]
10
+
11
+ ## Detailed Description
12
+
13
+ The Wait-ScriptSession cmdlet waits for script session to complete before it displays the command prompt or allows the script to continue. You can wait until any script session is complete, or until all script sessions are complete, and you can set a maximum wait time for the script session. When the commands in the script session are complete, Wait-ScriptSession displays the command prompt and returns a script session object so that you can pipe it to another command. You can use Wait-ScriptSession cmdlet to wait for script sessions, such as those that were started by using the Start-ScriptSession cmdlet.
14
+
15
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
16
+
17
+ ## Parameters
18
+
19
+ ### -Timeout &lt;Int32&gt;
20
+
21
+ The maximum time to wait for all the other running script sessions to complete.
22
+
23
+ | Aliases | |
24
+ | :--- | :--- |
25
+ | Required? | false |
26
+ | Position? | named |
27
+ | Default Value | |
28
+ | Accept Pipeline Input? | false |
29
+ | Accept Wildcard Characters? | false |
30
+
31
+ ### -Any &lt;SwitchParameter&gt;
32
+
33
+ Returns control to the script or displays the command prompt \(and returns the ScriptSession object\) when any script session completes. By default, Wait-ScriptSession waits until all of the specified jobs are complete before displaying the prompt.
34
+
35
+ | Aliases | |
36
+ | :--- | :--- |
37
+ | Required? | false |
38
+ | Position? | named |
39
+ | Default Value | |
40
+ | Accept Pipeline Input? | false |
41
+ | Accept Wildcard Characters? | false |
42
+
43
+ ### -Id &lt;String\[\]&gt;
44
+
45
+ Id\(s\) of the session to be stopped.
46
+
47
+ | Aliases | |
48
+ | :--- | :--- |
49
+ | Required? | true |
50
+ | Position? | named |
51
+ | Default Value | |
52
+ | Accept Pipeline Input? | true \(ByValue\) |
53
+ | Accept Wildcard Characters? | false |
54
+
55
+ ### -Session &lt;ScriptSession\[\]&gt;
56
+
57
+ Session\(s\) to be stopped.
58
+
59
+ | Aliases | |
60
+ | :--- | :--- |
61
+ | Required? | true |
62
+ | Position? | named |
63
+ | Default Value | |
64
+ | Accept Pipeline Input? | true \(ByValue\) |
65
+ | Accept Wildcard Characters? | false |
66
+
67
+ ## Inputs
68
+
69
+ The input type is the type of the objects that you can pipe to the cmdlet.
70
+
71
+ * System.String or Spe.Core.Host.ScriptSession
72
+
73
+ ## Outputs
74
+
75
+ The output type is the type of the objects that the cmdlet emits.
76
+
77
+ * Spe.Core.Host.ScriptSession
78
+
79
+ ## Notes
80
+
81
+ Help Author: Adam Najmanowicz, Michael West
82
+
83
+ ## Examples
84
+
85
+ ### EXAMPLE
86
+
87
+ ```powershell
88
+ PS master:\> Wait-ScriptSession -Id "My Background Script Session"
89
+ ```
90
+
91
+ ## Related Topics
92
+
93
+ * [Get-ScriptSession](get-scriptsession.md)
94
+ * [Receive-ScriptSession](receive-scriptsession.md)
95
+ * [Remove-ScriptSession](remove-scriptsession.md)
96
+ * [Start-ScriptSession](start-scriptsession.md)
97
+ * [Stop-ScriptSession](stop-scriptsession.md)
98
+ * [https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/](https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/)
99
+ * [https://git.io/spe](https://git.io/spe)
100
+
@@ -0,0 +1,82 @@
1
+ # Write-Log
2
+
3
+ Writes text to the Sitecore event log.
4
+
5
+ ## Syntax
6
+
7
+ Write-Log \[\[-Object\] &lt;Object&gt;\] \[-Separator &lt;Object&gt;\] \[-Log &lt;Debug \| Info \| Warning \| Error \| Fatal \| None&gt;\]
8
+
9
+ ## Detailed Description
10
+
11
+ The Write-Log command writes text to the Sitecore event log with the specified logging level.
12
+
13
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
14
+
15
+ ## Parameters
16
+
17
+ ### -Object &lt;Object&gt;
18
+
19
+ Specifies the object to write to the log.
20
+
21
+ | Aliases | |
22
+ | :--- | :--- |
23
+ | Required? | false |
24
+ | Position? | 1 |
25
+ | Default Value | |
26
+ | Accept Pipeline Input? | true \(ByValue\) |
27
+ | Accept Wildcard Characters? | false |
28
+
29
+ ### -Separator &lt;Object&gt;
30
+
31
+ Strings the output together with the specified text.
32
+
33
+ | Aliases | |
34
+ | :--- | :--- |
35
+ | Required? | false |
36
+ | Position? | named |
37
+ | Default Value | |
38
+ | Accept Pipeline Input? | false |
39
+ | Accept Wildcard Characters? | false |
40
+
41
+ ### -Log &lt;LogNotificationLevel&gt;
42
+
43
+ Specifies the Sitecore logging level.
44
+
45
+ | Aliases | |
46
+ | :--- | :--- |
47
+ | Required? | false |
48
+ | Position? | named |
49
+ | Default Value | |
50
+ | Accept Pipeline Input? | false |
51
+ | Accept Wildcard Characters? | false |
52
+
53
+ ## Inputs
54
+
55
+ The input type is the type of the objects that you can pipe to the cmdlet.
56
+
57
+ * System.String
58
+
59
+ Represents the identity of a role.
60
+
61
+ ## Outputs
62
+
63
+ The output type is the type of the objects that the cmdlet emits.
64
+
65
+ * None.
66
+
67
+ ## Notes
68
+
69
+ Help Author: Adam Najmanowicz, Michael West
70
+
71
+ ## Examples
72
+
73
+ ### EXAMPLE
74
+
75
+ ```powershell
76
+ PS master:\> Write-Log "Information."
77
+ ```
78
+
79
+ ## Related Topics
80
+
81
+ * [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/)
82
+
@@ -0,0 +1,2 @@
1
+ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp";
2
+ export declare function getPowershellDocumentationTool(server: McpServer): void;
@@ -0,0 +1,47 @@
1
+ import { safeMcpResponse } from "../../helper.js";
2
+ import path from "node:path";
3
+ import fs from "node:fs";
4
+ import { fileURLToPath } from "node:url";
5
+ export function getPowershellDocumentationTool(server) {
6
+ server.tool("get-powershell-documentation", "Gets the documentation describing all Sitecore Powershell commands.", {}, async () => {
7
+ const getMarkdown = async () => {
8
+ const __filename = fileURLToPath(import.meta.url);
9
+ const __dirname = path.dirname(__filename);
10
+ const documentationDir = path.resolve(__dirname, "documentation");
11
+ const markdownFiles = getAllMarkdownFiles(documentationDir);
12
+ const separator = '\n\n---\n\n';
13
+ let mergedContent = '';
14
+ for (const mdFile of markdownFiles) {
15
+ const content = fs.readFileSync(mdFile, "utf8");
16
+ if (mergedContent) {
17
+ mergedContent += separator;
18
+ }
19
+ mergedContent += content;
20
+ }
21
+ return new Promise((resolve) => {
22
+ resolve({
23
+ isError: false,
24
+ content: [
25
+ { type: "text", text: mergedContent }
26
+ ]
27
+ });
28
+ });
29
+ };
30
+ return safeMcpResponse(getMarkdown());
31
+ });
32
+ }
33
+ function getAllMarkdownFiles(dir) {
34
+ let results = [];
35
+ const list = fs.readdirSync(dir, { withFileTypes: true });
36
+ for (const file of list) {
37
+ const filePath = path.join(dir, file.name);
38
+ if (file.isDirectory()) {
39
+ results = results.concat(getAllMarkdownFiles(filePath));
40
+ }
41
+ else if (file.isFile() && file.name.endsWith(".md")) {
42
+ results.push(filePath);
43
+ }
44
+ }
45
+ return results;
46
+ }
47
+ //# sourceMappingURL=get-powershell-documentation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-powershell-documentation.js","sourceRoot":"","sources":["../../../src/tools/powershell/get-powershell-documentation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,UAAU,8BAA8B,CAAC,MAAiB;IAC5D,MAAM,CAAC,IAAI,CACP,8BAA8B,EAC9B,qEAAqE,EACrE,EAAE,EACF,KAAK,IAAI,EAAE;QACP,MAAM,WAAW,GAAG,KAAK,IAA6B,EAAE;YACpD,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC3C,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YAClE,MAAM,aAAa,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;YAE5D,MAAM,SAAS,GAAG,aAAa,CAAC;YAChC,IAAI,aAAa,GAAG,EAAE,CAAC;YAEvB,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;gBACjC,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAChD,IAAI,aAAa,EAAE,CAAC;oBAChB,aAAa,IAAI,SAAS,CAAC;gBAC/B,CAAC;gBACD,aAAa,IAAI,OAAO,CAAC;YAC7B,CAAC;YAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,OAAO,CAAC;oBACJ,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE;wBACL,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE;qBACxC;iBACJ,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,OAAO,eAAe,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1C,CAAC,CACJ,CAAC;AACN,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAW;IACpC,IAAI,OAAO,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACrB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5D,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp";
2
+ import type { Config } from "../../config.js";
3
+ export declare function runPowershellScriptTool(server: McpServer, config: Config): void;
@@ -0,0 +1,13 @@
1
+ import { safeMcpResponse } from "../../helper.js";
2
+ import { z } from "zod";
3
+ import { runGenericPowershellCommand } from "./simple/generic.js";
4
+ export function runPowershellScriptTool(server, config) {
5
+ server.tool("run-powershell-script", "Runs a PowerShell script and returns the output.", {
6
+ script: z.string()
7
+ .describe("The Powershell script to run."),
8
+ }, async (params) => {
9
+ const command = params.script;
10
+ return safeMcpResponse(runGenericPowershellCommand(config, command, {}));
11
+ });
12
+ }
13
+ //# sourceMappingURL=run-powershell-script.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-powershell-script.js","sourceRoot":"","sources":["../../../src/tools/powershell/run-powershell-script.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAElE,MAAM,UAAU,uBAAuB,CAAC,MAAiB,EAAE,MAAc;IACrE,MAAM,CAAC,IAAI,CACP,uBAAuB,EACvB,kDAAkD,EAClD;QACI,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;aACb,QAAQ,CAAC,+BAA+B,CAAC;KACjD,EACD,KAAK,EAAE,MAAM,EAAE,EAAE;QACb,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC9B,OAAO,eAAe,CAAC,2BAA2B,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7E,CAAC,CACJ,CAAC;AACN,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp";
2
+ import type { Config } from "../../config.js";
3
+ export declare function getSitecoreCliDocumentation(server: McpServer, config: Config): void;
@@ -0,0 +1,24 @@
1
+ import { safeMcpResponse } from "../../helper.js";
2
+ import path from "node:path";
3
+ import fs from "node:fs";
4
+ import { fileURLToPath } from "node:url";
5
+ export function getSitecoreCliDocumentation(server, config) {
6
+ server.tool("sitecore-cli-documentation", "Gets Sitecore CLI documentation describing the most often used commands like index rebuild, item serialization, etc.", {}, async (params) => {
7
+ const getMarkdown = async () => {
8
+ const __filename = fileURLToPath(import.meta.url);
9
+ const __dirname = path.dirname(__filename);
10
+ const markdownPath = path.resolve(__dirname, "sitecore-cli-documentation.md");
11
+ const markDown = fs.readFileSync(markdownPath, "utf8");
12
+ return new Promise((resolve) => {
13
+ resolve({
14
+ isError: false,
15
+ content: [
16
+ { type: "text", text: markDown }
17
+ ]
18
+ });
19
+ });
20
+ };
21
+ return safeMcpResponse(getMarkdown());
22
+ });
23
+ }
24
+ //# sourceMappingURL=get-sitecore-cli-documentation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-sitecore-cli-documentation.js","sourceRoot":"","sources":["../../../src/tools/sitecore-cli/get-sitecore-cli-documentation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,UAAU,2BAA2B,CAAC,MAAiB,EAAE,MAAc;IACzE,MAAM,CAAC,IAAI,CACP,4BAA4B,EAC5B,sHAAsH,EACtH,EAAG,EACH,KAAK,EAAE,MAAM,EAAE,EAAE;QACb,MAAM,WAAW,GAAG,KAAK,IAA6B,EAAE;YACpD,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;YAC9E,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YACvD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,OAAO,CAAC;oBACJ,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE;wBACL,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;qBACnC;iBACJ,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,OAAO,eAAe,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1C,CAAC,CACJ,CAAC;AACN,CAAC"}
@@ -0,0 +1,70 @@
1
+ # Sitecore CLI
2
+
3
+ ## Items serialization
4
+
5
+ ### Push subcommand
6
+
7
+ The `push` command takes items serialized as `.yml` files on disk and pushes them to a destination Sitecore instance. The push operation uses serialization `Module.json` files to determine the items included in the serialization process. During the push operation, the serialization engine evaluates existing serialized items on the file system and performs a deep comparison of the same Items in the source Sitecore instance.
8
+
9
+ `dotnet sitecore ser push`
10
+
11
+ | Parameter | Description |
12
+ |--|--|
13
+ | -i, --include | Specify module configurations to include. Supports module name, tags. Wildcards and multiple values are allowed. |
14
+ | -e, --exclude <exclude> | Specify module configurations to exclude explicitly. Supports module name, tags. Wildcards and multiple values are allowed. |
15
+ | -p, --publish | Publish synced items. Not recommended to use with Publishing Service due to performance drop. |
16
+
17
+
18
+ ### Pull subcommand
19
+
20
+ The `pull` subcommand takes items from Sitecore, serializes them, and stores them as `.yml` files on a given file system path. The subcommand uses `Module.json` files to determine what items are included in the serialization process. During the pull operation, the serialization engine evaluates existing serialized items on disk and performs a deep comparison of the same items in the source Sitecore instance.
21
+
22
+ `dotnet sitecore ser pull`
23
+
24
+
25
+ | Parameter | Description |
26
+ |--|--|
27
+ | -i, --include | Specify module configurations to include. Supports module name, tags. Wildcards and multiple values are allowed. |
28
+ | -e, --exclude | Specify module configurations to exclude explicitly. Supports module name, tags. Wildcards and multiple values are allowed. |
29
+
30
+ ### Validate subcommand
31
+
32
+ The `validate` subcommand ensures file system integrity of serialized items and paths. Additionally, by using the `--fix (-f)` argument option flag, the command can attempt to auto-correct identified issues. The subcommand evaluates all serialized paths and subtrees on the file system configured in serialization `Module.json` files and performs the following checks on the file system:
33
+
34
+ - Invalid physical path.
35
+ - Orphaned parent ID.
36
+ - Non-included item.
37
+ - Empty folder.
38
+ - Duplicate item ID.
39
+ - Non-unique path.
40
+
41
+ `dotnet sitecore ser validate`
42
+
43
+ | Parameter | Description |
44
+ |--|--|
45
+ | -i, --include | Specify module configurations to include. Supports module name, tags. Wildcards and multiple values are allowed. |
46
+ | -e, --exclude <exclude> | Specify module configurations to exclude explicitly. Supports module name, tags. Wildcards and multiple values are allowed. |
47
+ | -f, --fix | Execute possible fix operations when validating the serialized items. |
48
+
49
+
50
+ ## Indexing
51
+ This command automates indexing operations.
52
+
53
+ ### List subcommand
54
+ Provides the list of available indexes from the environment
55
+
56
+ `dotnet sitecore index list`
57
+
58
+ ### Schema-populate subcommand
59
+ Populates the managed schema
60
+
61
+ `dotnet sitecore index schema-populate`
62
+
63
+ ### Rebuild subcommand
64
+ Rebuilds sitecore index(es)
65
+
66
+ `dotnet sitecore index rebuild`
67
+
68
+ | Parameter | Description |
69
+ |--|--|
70
+ | -i, --indexes | Rebuild the specified indexes. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antonytm/mcp-sitecore-server",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "description": "A Model Context Protocol server for Sitecore",
5
5
  "files": [
6
6
  "dist",
@@ -17,25 +17,25 @@
17
17
  "bundle": "rollup -c",
18
18
  "prepare": "npm run build",
19
19
  "watch": "tsc --watch",
20
- "inspector": "npx @modelcontextprotocol/inspector@0.15.0 dist/index.js",
20
+ "inspector": "npx @modelcontextprotocol/inspector@latest dist/index.js",
21
21
  "start": "npm run build && node dist/app.js",
22
22
  "start:sse": "npm run build && cross-env TRANSPORT=sse node dist/index.js",
23
23
  "start:streamable-http": "npm run build && cross-env TRANSPORT=streamable-http node dist/index.js",
24
24
  "start:stdio": "npm run build && cross-env TRANSPORT=stdio node dist/index.js",
25
25
  "run": "npm run build && node dist/run.js",
26
26
  "test": "npm run build && npm run bundle && vitest run",
27
- "docker:windows:build": "docker build -t antonytm/mcp-sitecore-windows:1.0.0 -t antonytm/mcp-sitecore-windows:latest --file .\\docker\\windows\\Dockerfile .",
27
+ "docker:windows:build": "docker build -t antonytm/mcp-sitecore-windows:1.2.0 -t antonytm/mcp-sitecore-windows:latest --file .\\docker\\windows\\Dockerfile .",
28
28
  "docker:windows:run": "docker run -it --rm -p 4001:3001 antonytm/mcp-sitecore-windows:latest",
29
- "docker:windows:push": "docker push antonytm/mcp-sitecore-windows:1.0.0 && docker push antonytm/mcp-sitecore-windows:latest",
29
+ "docker:windows:push": "docker push antonytm/mcp-sitecore-windows:1.2.0 && docker push antonytm/mcp-sitecore-windows:latest",
30
30
  "docker:windows": "npm run docker:windows:build && npm run docker:windows:push",
31
- "docker:linux:build": "docker build -t antonytm/mcp-sitecore-linux:1.0.0 -t antonytm/mcp-sitecore-linux:latest --file ./docker/linux/Dockerfile .",
31
+ "docker:linux:build": "docker build -t antonytm/mcp-sitecore-linux:1.2.0 -t antonytm/mcp-sitecore-linux:latest --file ./docker/linux/Dockerfile .",
32
32
  "docker:linux:run": "docker run -it --rm -p 4001:3001 antonytm/mcp-sitecore-linux:latest",
33
- "docker:linux:push": "docker push antonytm/mcp-sitecore-linux:1.0.0 && docker push antonytm/mcp-sitecore-linux:latest",
33
+ "docker:linux:push": "docker push antonytm/mcp-sitecore-linux:1.2.0 && docker push antonytm/mcp-sitecore-linux:latest",
34
34
  "docker:linux": "npm run docker:linux:build && npm run docker:linux:push"
35
35
  },
36
36
  "dependencies": {
37
37
  "@antonytm/clixml-parser": "latest",
38
- "@modelcontextprotocol/sdk": "^1.15.1",
38
+ "@modelcontextprotocol/sdk": "^1.16.0",
39
39
  "dotenv": "^16.6.1",
40
40
  "graphql": "^16.10.0"
41
41
  },
@@ -46,7 +46,7 @@
46
46
  "@rollup/plugin-json": "^6.1.0",
47
47
  "@rollup/plugin-node-resolve": "^16.0.1",
48
48
  "@types/express": "^5.0.1",
49
- "@types/node": "^22.16.3",
49
+ "@types/node": "^22.16.5",
50
50
  "cross-env": "^7.0.3",
51
51
  "express": "^5.1.0",
52
52
  "rollup": "^4.44.2",