-
Notifications
You must be signed in to change notification settings - Fork 29
Expand file tree
/
Copy pathpackage.json
More file actions
1620 lines (1620 loc) · 53.3 KB
/
package.json
File metadata and controls
1620 lines (1620 loc) · 53.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"name": "viva-connections-toolkit",
"displayName": "SharePoint Framework Toolkit",
"description": "SharePoint Framework Toolkit aims to boost your productivity in developing and managing SharePoint Framework solutions helping at every stage of your development flow, from setting up your development workspace to deploying a solution straight to your tenant without the need to leave VS Code and now even create a CI/CD pipeline to introduce automate deployment of your app. This toolkit is provided by the community.",
"version": "4.18.0",
"publisher": "m365pnp",
"preview": false,
"homepage": "https://pnp.github.io/vscode-viva",
"icon": "assets/logo-large.png",
"engines": {
"vscode": "^1.93.0"
},
"categories": [
"Snippets",
"Extension Packs",
"Other",
"AI",
"Chat"
],
"repository": {
"type": "git",
"url": "https://github.com/pnp/vscode-viva"
},
"bugs": {
"url": "https://github.com/pnp/vscode-viva/issues"
},
"qna": "https://github.com/pnp/vscode-viva/discussions",
"keywords": [
"SPFx",
"SharePoint Framework",
"Viva",
"Viva Connections",
"Microsoft 365",
"SharePoint",
"Microsoft Teams",
"Outlook",
"Office"
],
"activationEvents": [
"workspaceContains:**/project.pnp",
"workspaceContains:**/config/package-solution.json",
"onView:pnp-view"
],
"extensionDependencies": [
"vsls-contrib.codetour",
"eliostruyf.spfx-snippets"
],
"license": "MIT",
"main": "./dist/extension.js",
"contributes": {
"chatParticipants": [
{
"id": "spfx-toolkit.pnp",
"fullName": "SPFx Toolkit",
"name": "spfx",
"description": "How can I help you with SPFx development? Use /new command for job specific support.",
"isSticky": true,
"commands": [
{
"name": "new",
"isSticky": true,
"description": "Create a new SharePoint Framework project"
}
]
}
],
"languageModelTools": [
{
"name": "install_spo_app",
"tags": [
"sharepoint",
"app",
"spfx-toolkit"
],
"toolReferenceName": "SharePointAppInstall",
"displayName": "Install a SharePoint app in a site",
"modelDescription": "Installs a SharePoint Framework (SPFx) application from the specified app catalog to a SharePoint Online site using the app's unique identifier (GUID). Use this tool after an app has been uploaded to either the tenant or a site collection app catalog to make it available on a specific site. It requires Microsoft 365 authentication and permissions to both the app catalog and the target site. Apps from tenant app catalog can be installed on any site, but apps from site collection app catalogs can only be installed within the same site collection. Only one app can be installed per operation, and the exact app GUID must exist in the specified catalog. The target site must be accessible, the app must already be deployed in the catalog, and installation may fail if dependencies are not met. If the app is already installed, the operation will fail with an error.",
"userDescription": "Installs an app from the specified app catalog in the site.",
"canBeReferencedInPrompt": true,
"icon": "$(package)",
"inputSchema": {
"type": "object",
"properties": {
"siteUrl": {
"type": "string",
"description": "URL of the site. This option is required.",
"default": ""
},
"id": {
"type": "string",
"description": "GUID of the app to install. This option is required.",
"default": ""
},
"appCatalogScope": {
"type": "string",
"description": "Scope of the app catalog. Allowed values: tenant, sitecollection. Defaults to tenant. This option is optional.",
"default": ""
}
}
}
},
{
"name": "list_spo_app_instances",
"tags": [
"sharepoint",
"app",
"spfx-toolkit"
],
"toolReferenceName": "SharePointAppInstanceList",
"displayName": "List installed SharePoint apps in a site",
"modelDescription": "Retrieves a list of SharePoint Framework (SPFx) applications that are currently installed and deployed on a specific SharePoint Online site. This tool shows the actual app instances running on the site, including details like app ID, title, description, app status, and more. Use this tool to inventory installed apps on a site. The tool requires Microsoft 365 authentication and read permissions to the target site. This is different from listing apps in catalogs, this shows only the apps that are actually installed and running on the specified site.",
"userDescription": "Lists all SharePoint apps currently installed on the specified site.",
"canBeReferencedInPrompt": true,
"icon": "$(list-unordered)",
"inputSchema": {
"type": "object",
"properties": {
"siteUrl": {
"type": "string",
"description": "URL of the site collection to retrieve the installed apps for. This option is required.",
"default": ""
}
}
}
},
{
"name": "list_spo_app",
"tags": [
"sharepoint",
"app",
"spfx-toolkit"
],
"toolReferenceName": "SharePointAppList",
"displayName": "List SharePoint apps",
"modelDescription": "Returns the list of SharePoint Framework apps from the specified app catalog. This tool can list apps from the tenant-wide app catalog (default) or from a specific site collection app catalog when appCatalogScope is set to 'sitecollection' and appCatalogUrl is provided. This tool returns detailed information about each app including ID, title, deployment status, enablement state, and more. Use this tool when you need to inventory apps, check deployment status, or verify which apps are available in app catalogs before performing app management operations. The tool requires Microsoft 365 authentication and appropriate permissions to access the specified app catalog.",
"userDescription": "Lists SharePoint apps from the tenant or site collection app catalog.",
"canBeReferencedInPrompt": true,
"icon": "$(search)",
"inputSchema": {
"type": "object",
"properties": {
"appCatalogScope": {
"type": "string",
"description": "Scope of the app catalog. Allowed values: tenant, sitecollection. Defaults to tenant. This option is optional.",
"default": ""
},
"appCatalogUrl": {
"type": "string",
"description": "URL of the tenant or site collection app catalog. It must be specified when the appCatalogScope is sitecollection.",
"default": ""
}
}
}
},
{
"name": "uninstall_spo_app",
"tags": [
"sharepoint",
"app",
"spfx-toolkit"
],
"toolReferenceName": "SharePointAppUninstall",
"displayName": "Uninstall a SharePoint app from a site",
"modelDescription": "Uninstalls SharePoint Framework applications from specific SharePoint Online sites, making them unavailable to end users on that site while keeping the app available in the app catalog. This tool uninstalls apps that are currently deployed to a site by using the app's unique identifier (GUID). Use this tool when you need to uninstall apps from specific sites, clean up unused applications, or manage app lifecycle. The app remains in the app catalog and can be reinstalled later. Apps from tenant app catalog can be uninstalled from any site, but apps from site collection app catalogs can only be uninstalled within the same site collection. The tool requires Microsoft 365 authentication and appropriate permissions to the target site. Additional constraints: Can only uninstall one app per operation, requires exact app GUID, target site must be accessible and exist, will not fail if the app is not currently installed on the target site (operation will complete successfully with no action taken), and may fail if there are dependencies or active usage of the app.",
"userDescription": "Uninstalls an app from the specified site without prompting for confirmation.",
"canBeReferencedInPrompt": true,
"icon": "$(remove)",
"inputSchema": {
"type": "object",
"properties": {
"siteUrl": {
"type": "string",
"description": "URL of the site. This option is required.",
"default": ""
},
"id": {
"type": "string",
"description": "GUID of the app to uninstall. This option is required.",
"default": ""
},
"appCatalogScope": {
"type": "string",
"description": "Scope of the app catalog. Allowed values: tenant, sitecollection. Defaults to tenant. This option is optional.",
"default": ""
}
}
}
},
{
"name": "upgrade_spo_app",
"tags": [
"sharepoint",
"app",
"spfx-toolkit"
],
"toolReferenceName": "SharePointAppUpgrade",
"displayName": "Upgrade a SharePoint app in the specified site",
"modelDescription": "Upgrades a SharePoint Framework (SPFx) application in a SharePoint Online site using the app's unique identifier (GUID). Use this tool to upgrade an existing app to its latest version. It requires Microsoft 365 authentication and permissions to both the app catalog and the target site. Apps from tenant app catalog can be upgraded on any site, but apps from site collection app catalogs can only be upgraded within the same site collection. Only one app can be upgraded per operation, and the exact app GUID must exist in the specified catalog. The target site must be accessible, the app must already be deployed in the catalog, and upgrading may fail if dependencies are not met.",
"userDescription": "Upgrades an app from the specified app catalog in the site.",
"canBeReferencedInPrompt": true,
"icon": "$(sync)",
"inputSchema": {
"type": "object",
"properties": {
"siteUrl": {
"type": "string",
"description": "Absolute URL of the site to upgrade the app in. This option is required.",
"default": ""
},
"id": {
"type": "string",
"description": "GUID of the app to upgrade. This option is required.",
"default": ""
},
"appCatalogScope": {
"type": "string",
"description": "Scope of the app catalog. Allowed values: tenant, sitecollection. Defaults to tenant. This option is optional.",
"default": ""
}
}
}
},
{
"name": "add_spo_list",
"tags": [
"sharepoint",
"list",
"spfx-toolkit"
],
"toolReferenceName": "SharePointListAdd",
"displayName": "Create a SharePoint list",
"modelDescription": "This tool creates lists based on predefined SharePoint list templates (e.g., GenericList, DocumentLibrary, Events) and allows configuration of advanced features such as versioning controls, folder creation, commenting capabilities, and content type management. Returns confirmation of list creation with the list's details. Use this tool when you need to provision new lists for data storage, document management, task tracking, or other collaborative scenarios in SharePoint Online. This tool should NOT be used to modify existing lists.",
"userDescription": "Creates list in the specified site.",
"canBeReferencedInPrompt": true,
"icon": "$(add)",
"inputSchema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the list to add. This option is required.",
"default": ""
},
"webUrl": {
"type": "string",
"description": "URL of the site where the list should be added. This option is required.",
"default": ""
},
"baseTemplate": {
"type": "string",
"description": "The list definition type on which the list is based. Allowed values Announcements, Contacts, CustomGrid, DataSources, DiscussionBoard, DocumentLibrary, Events, GanttTasks, GenericList, IssuesTracking, Links, NoCodeWorkflows, PictureLibrary, Survey, Tasks, WebPageLibrary, WorkflowHistory, WorkflowProcess, XmlForm. Default value is GenericList. This option is optional.",
"default": ""
},
"description": {
"type": "string",
"description": "The description for the list. This option is optional.",
"default": ""
},
"allowDeletion": {
"type": "boolean",
"description": "Specifies whether the list can be deleted. This option is optional.",
"default": false
},
"contentTypesEnabled": {
"type": "boolean",
"description": "Specifies whether content types are enabled for the list. This option is optional.",
"default": false
},
"disableCommenting": {
"type": "boolean",
"description": "Specifies whether commenting on list items is disabled. This option is optional.",
"default": false
},
"disableGridEditing": {
"type": "boolean",
"description": "Specifies whether grid editing is disabled for the list. This option is optional.",
"default": false
},
"draftVersionVisibility": {
"type": "string",
"description": "Specifies the visibility of draft versions in the list. Allowed values: Reader, Author, Approver. This option is optional.",
"default": ""
},
"enableFolderCreation": {
"type": "boolean",
"description": "Specifies whether folder creation is enabled for the list. This option is optional.",
"default": false
},
"enableMinorVersions": {
"type": "boolean",
"description": "Specifies whether minor versions are enabled for the list. This option is optional.",
"default": false
},
"enableVersioning": {
"type": "boolean",
"description": "Specifies whether versioning is enabled for the list. This option is optional.",
"default": false
},
"forceCheckout": {
"type": "boolean",
"description": "Specifies whether forced checkout is enabled for the list. This option is optional.",
"default": false
},
"hidden": {
"type": "boolean",
"description": "Specifies whether the list is hidden from the browser. This option is optional.",
"default": false
},
"noCrawl": {
"type": "boolean",
"description": "Specifies whether the list should be excluded from search crawling. This option is optional.",
"default": false
}
}
}
},
{
"name": "get_spo_list",
"tags": [
"sharepoint",
"list",
"spfx-toolkit"
],
"toolReferenceName": "SharePointListGet",
"displayName": "Get a SharePoint list",
"modelDescription": "Use this tool when you need to verify if a specific list exists on a site, retrieve list metadata for validation or documentation purposes, check list properties before performing operations, or inspect permissions assigned to the list. Do not use this tool to list all lists on a site.",
"userDescription": "Gets information about a specific SharePoint list.",
"canBeReferencedInPrompt": true,
"icon": "$(search)",
"inputSchema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the list to retrieve information for. This option is required.",
"default": ""
},
"webUrl": {
"type": "string",
"description": "URL of the site where the list to retrieve is located. This option is required.",
"default": ""
},
"withPermissions": {
"type": "boolean",
"description": "Set to true if you want to return associated roles and permissions of the list. This option is optional.",
"default": false
}
}
}
},
{
"name": "remove_spo_list",
"tags": [
"sharepoint",
"list",
"spfx-toolkit"
],
"toolReferenceName": "SharePointListRemove",
"displayName": "Remove a SharePoint list",
"modelDescription": "This tool deletes lists from SharePoint Online sites, either sending them to the site's recycle bin (when recycle is true) or permanently removing them (when recycle is false or omitted). Use this tool to clean up unused lists, remove test data, or manage site content.",
"userDescription": "Removes the specified list from the site.",
"canBeReferencedInPrompt": true,
"icon": "$(trash)",
"inputSchema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the list to remove. This option is required.",
"default": ""
},
"webUrl": {
"type": "string",
"description": "URL of the site where the list to remove is located. This option is required.",
"default": ""
},
"recycle": {
"type": "boolean",
"description": "When set to true, sends the list to the site's recycle bin instead of permanently removing it. This option is optional.",
"default": false
}
}
}
},
{
"name": "add_spo_page",
"tags": [
"sharepoint",
"page",
"spfx-toolkit"
],
"toolReferenceName": "SharePointPageAdd",
"displayName": "Add a SharePoint Page",
"modelDescription": "This tool creates a new SharePoint page on a specified site. Upon success this tool will not provide any response. Use this tool to add a page on an existing SharePoint site to a sitePages library.",
"userDescription": "Creates a page.",
"canBeReferencedInPrompt": true,
"icon": "$(add)",
"inputSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the page to create. This option is required.",
"default": ""
},
"webUrl": {
"type": "string",
"description": "URL of the site where the page should be created. This option is required.",
"default": ""
},
"title": {
"type": "string",
"description": "Title of the page to create. If not specified, will use the page name as its title. This option is optional.",
"default": ""
},
"layoutType": {
"type": "string",
"description": "Layout of the page. Allowed values: 'Article', 'Home', 'SingleWebPartAppPage', 'RepostPage', 'HeaderlessSearchResults', 'Spaces', 'Topic'. Default 'Article'. This option is optional.",
"default": "Article"
},
"promoteAs": {
"type": "string",
"description": "Create the page for a specific purpose. Allowed values 'HomePage', 'NewsPage', 'Template'. This option is optional.",
"default": ""
},
"commentsEnabled": {
"type": "boolean",
"description": "Set to enable comments on the page. This option is optional.",
"default": false
},
"description": {
"type": "string",
"description": "The description to set for the page. This option is optional.",
"default": ""
}
}
}
},
{
"name": "get_spo_page",
"tags": [
"sharepoint",
"page",
"spfx-toolkit"
],
"toolReferenceName": "SharePointPageGet",
"displayName": "Get a SharePoint Page",
"modelDescription": "Retrieves detailed information about a specific modern SharePoint page. Returns page metadata including title, layout type, canvas content, and status. Use this tool to get details for a specific page by name, OR use the default parameter to get the site's home page. Do not provide both name and default. Do not use this tool to list multiple pages. Requires Microsoft 365 authentication and read permissions on the target site.",
"userDescription": "Gets information about a specific SharePoint page.",
"canBeReferencedInPrompt": true,
"icon": "$(info)",
"inputSchema": {
"type": "object",
"properties": {
"webUrl": {
"type": "string",
"description": "URL of the site where the page is located. This option is required.",
"default": ""
},
"name": {
"type": "string",
"description": "Name of the page to retrieve (e.g., 'home.aspx'). Do not use if 'default' is true.",
"default": ""
},
"default": {
"type": "boolean",
"description": "Set to true to retrieve the site's home page. Do not use if 'name' is specified.",
"default": false
},
"metadataOnly": {
"type": "boolean",
"description": "Set to only retrieve page metadata without canvas content. This option is optional.",
"default": false
}
}
}
},
{
"name": "list_spo_page",
"tags": [
"sharepoint",
"page",
"spfx-toolkit"
],
"toolReferenceName": "SharePointPageList",
"displayName": "List SharePoint Pages",
"modelDescription": "Retrieves a list of all modern SharePoint pages from a site. Returns page metadata including page names, URLs, and properties. Use this tool to inventory pages or check what pages exist on a site. Do not use this tool to retrieve detailed information about a single specific page. Requires Microsoft 365 authentication and read permissions on the target site.",
"userDescription": "Lists all modern pages from a SharePoint site.",
"canBeReferencedInPrompt": true,
"icon": "$(list-unordered)",
"inputSchema": {
"type": "object",
"properties": {
"webUrl": {
"type": "string",
"description": "URL of the site from which to retrieve pages. This option is required.",
"default": ""
}
}
}
},
{
"name": "copy_spo_page",
"tags": [
"sharepoint",
"page",
"spfx-toolkit"
],
"toolReferenceName": "SharePointPageCopy",
"displayName": "Copy a SharePoint Page",
"modelDescription": "Copies a modern SharePoint page within the same site or to a different site. Supports copying page templates. Use relative path in targetUrl for same-site copies or absolute URL for cross-site copies. Set overwrite to true to replace existing pages. Requires Microsoft 365 authentication and read permissions on the source site, write permissions on the target site.",
"userDescription": "Copies a page.",
"canBeReferencedInPrompt": true,
"icon": "$(copy)",
"inputSchema": {
"type": "object",
"properties": {
"webUrl": {
"type": "string",
"description": "URL of the site where the source page is located. This option is required.",
"default": ""
},
"sourceName": {
"type": "string",
"description": "Name of the source page to copy (e.g., 'home.aspx' or 'templates/PageTemplate.aspx'). This option is required.",
"default": ""
},
"targetUrl": {
"type": "string",
"description": "Target URL for the copied page. Use relative path (e.g., 'home-copy.aspx') for same-site copies or absolute URL for cross-site copies. This option is required.",
"default": ""
},
"overwrite": {
"type": "boolean",
"description": "Set to true to overwrite the target page if it already exists.",
"default": false
}
}
}
},
{
"name": "remove_spo_page",
"tags": [
"sharepoint",
"page",
"spfx-toolkit"
],
"toolReferenceName": "SharePointPageRemove",
"displayName": "Remove a SharePoint Page",
"modelDescription": "Permanently removes or recycles a specific modern SharePoint page from a site. Use this tool when the user explicitly requests to delete a page. This action is destructive. Requires Microsoft 365 authentication and read permissions on the target site.",
"userDescription": "Removes a page.",
"canBeReferencedInPrompt": true,
"icon": "$(trash)",
"inputSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the page to remove. This option is required.",
"default": ""
},
"webUrl": {
"type": "string",
"description": "URL of the site where the page is located. This option is required.",
"default": ""
},
"recycle": {
"type": "boolean",
"description": "If true, moves the page to the recycle bin instead of permanently deleting it. Highly recommended.",
"default": false
},
"bypassSharedLock": {
"type": "boolean",
"description": "If true, removes the page even if it is locked for shared use.",
"default": false
}
}
}
},
{
"name": "spo_site_add",
"tags": [
"sharepoint",
"site",
"spfx-toolkit"
],
"toolReferenceName": "SharePointSiteAdd",
"displayName": "Add SharePoint Site",
"modelDescription": "Create a new SharePoint Online site. This tool may be used to create a CommunicationSite or a TeamSite. in case of TeamSite we need to provide the owners of the site and in case of CommunicationSite we need to specify the url.",
"userDescription": "Create a new SharePoint Online site.",
"canBeReferencedInPrompt": true,
"icon": "$(add)",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of sites to add. Allowed values TeamSite, CommunicationSite. This property is required.",
"default": "CommunicationSite"
},
"title": {
"type": "string",
"description": "Site title. This property is required.",
"default": ""
},
"url": {
"type": "string",
"description": "Site URL. In case of CommunicationSite this option is required.",
"default": ""
},
"description": {
"type": "string",
"description": "Site description. This property is optional.",
"default": ""
},
"owners": {
"type": "string",
"description": "Comma-separated list of user emails to set as site owners. In case of TeamSite this option is required.",
"default": ""
}
}
}
},
{
"name": "spo_site_remove",
"tags": [
"sharepoint",
"site",
"spfx-toolkit"
],
"toolReferenceName": "SharePointSiteRemove",
"displayName": "Remove SharePoint Site",
"modelDescription": "Remove a SharePoint Online site. This tool may be used to remove a site.",
"userDescription": "Remove a SharePoint Online site.",
"canBeReferencedInPrompt": true,
"icon": "$(trash)",
"inputSchema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of the site. This option is required.",
"default": ""
}
}
}
},
{
"name": "spo_site_get",
"tags": [
"sharepoint",
"site",
"spfx-toolkit"
],
"toolReferenceName": "SharePointSiteGet",
"displayName": "Get SharePoint Site",
"modelDescription": "Get a SharePoint Online site. This tool may be used to check if a site extist or to retrieve more information about a SharePoints site.",
"userDescription": "Get a SharePoint Online site.",
"canBeReferencedInPrompt": true,
"icon": "$(search)",
"inputSchema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of the site. This option is required.",
"default": ""
}
}
}
},
{
"name": "upgrade_spfx_project",
"tags": [
"sharepoint framework",
"SPFx",
"project",
"upgrade",
"spfx-toolkit"
],
"toolReferenceName": "SharePointFrameworkProjectUpgrade",
"displayName": "Upgrade SharePoint Framework project",
"modelDescription": "Allows retrieval of the steps required to upgrade a SharePoint Framework (SPFx) project to the latest version. The retrieved steps may be executed by the GitHub Copilot Agent to perform the upgrade.",
"userDescription": "Upgrade SharePoint Framework project.",
"canBeReferencedInPrompt": true,
"icon": "$(arrow-up)",
"inputSchema": {
"type": "object",
"properties": {
"toVersion": {
"type": "string",
"description": "Target version to upgrade the SharePoint Framework project to. This option is optional.",
"default": ""
}
}
}
},
{
"name": "setup_spfx_environment",
"tags": [
"sharepoint framework",
"SPFx",
"project",
"setup",
"spfx-toolkit"
],
"toolReferenceName": "SharePointFrameworkLocalEnvironmentSetup",
"displayName": "Set up local environment for SharePoint Framework development",
"modelDescription": "This tool will validate and help you set up your local environment for any version of SharePoint Framework development.",
"userDescription": "Set up local environment for SharePoint Framework development",
"canBeReferencedInPrompt": true,
"icon": "$(package)",
"inputSchema": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "SharePoint Framework version to which you want to set up your local environment. This option is optional. If not defined, it will set up the environment for the latest version of SharePoint Framework.",
"default": ""
}
}
}
}
],
"walkthroughs": [
{
"id": "spfx-toolkit-intro",
"title": "SharePoint Framework Toolkit Introduction",
"description": "Start your journey wih SharePoint Framework and learn how to boost your productivity in developing and managing SharePoint Framework solutions.",
"steps": [
{
"id": "intro-to-spfx",
"title": "Introduction to SharePoint Framework",
"description": "Learn SharePoint Framework and set up your Microsoft 365 tenant \n[Join the Microsoft 365 Developer Program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)",
"media": {
"markdown": "assets/walkthrough/spfx-intro.md"
}
},
{
"id": "set-up-local-workspace",
"title": "Validate your local workspace",
"description": "Validate if your local workspace is ready for SharePoint Framework development by checking and installing the required dependencies. \n[Validate local setup](command:spfx-toolkit.checkDependencies)",
"media": {
"markdown": "assets/walkthrough/validate-local-setup.md"
}
},
{
"id": "create-new-project",
"title": "Create new project",
"description": "Use the scaffolding form to create a new project or use one of the existing samples to kick off a new project and boost your development.\n[Create a new project](command:spfx-toolkit.createProject)\n[View samples](command:spfx-toolkit.samplesGallery)",
"media": {
"markdown": "assets/walkthrough/create-new-project.md"
}
},
{
"id": "tenant-details",
"title": "Sign in to Microsoft 365",
"description": "Retrieve tenant helpful information and Manage your SPFx projects. \nSign in to your tenant to get started. \n[Sign in to Microsoft 365](command:spfx-toolkit.login)",
"media": {
"markdown": "assets/walkthrough/tenant-details.md"
}
},
{
"id": "tasks",
"title": "Tasks",
"description": "Get to know the Gulp tasks and NPM scripts that are available in your SharePoint Framework project",
"media": {
"markdown": "assets/walkthrough/tasks.md"
}
},
{
"id": "actions",
"title": "Boost your development with actions",
"description": "Reduce the amount of context switching and automate your work with Actions. \nValidate your project, rename your solution, deploy it to any app catalog, grant API permissions ... and many more all without leaving the context of your work.",
"media": {
"markdown": "assets/walkthrough/actions.md"
}
},
{
"id": "coding-snippets",
"title": "Write code faster with coding snippets",
"description": "Write more with less using coding snippets",
"media": {
"markdown": "assets/walkthrough/coding-snippets.md"
}
},
{
"id": "cicd-workflow",
"title": "Create a CI/CD workflow for your SPFx project",
"description": "Create a GitHub Workflow or Azure DevOps pipeline to bundle, package, and deploy your SharePoint Framework project to any App Catalog. \n[Generate CI/CD workflow](command:spfx-toolkit.pipeline)",
"media": {
"markdown": "assets/walkthrough/cicd-workflow.md"
}
},
{
"id": "help",
"title": "Continue your learning and get additional tooling",
"description": "SharePoint Framework Toolkit is your single point to get to the official Microsoft documentation and learning regarding SharePoint Framework and additional tooling that will help you create apps for Microsoft 365.",
"media": {
"image": "docs/assets/images-vscode/help-and-feedback.png",
"altText": "help and feedback section"
}
},
{
"id": "Community",
"title": "Connect with the Microsoft 365 and Power Platform community",
"description": "Stay up to date and connected. \nVisit the [Microsoft 365 and Power Platform community](https://pnp.github.io/) to get more learning materials, guidance, tooling, and engage in community calls. \nJoin the [community Discord server](https://aka.ms/community/discord) to stay connected and help out others. \n Sharing is caring!",
"media": {
"image": "docs/assets/images-vscode/parker-pnp.png",
"altText": "PnP Parker"
}
}
]
}
],
"configuration": {
"title": "SharePoint Framework Toolkit",
"properties": {
"spfx-toolkit.nodeVersionManager": {
"title": "Node.js Version Manager",
"type": "string",
"default": "none",
"enum": [
"nvm",
"nvs",
"none"
],
"description": "Choose your preferred Node.js version manager. Choose between `nvs`, `nvm`, or `none`."
},
"spfx-toolkit.packageManager": {
"title": "Node Package Manager",
"type": "string",
"default": "npm",
"enum": [
"npm",
"pnpm",
"yarn"
],
"description": "Choose your preferred Node package manager. Choose between `npm`, `pnpm`, or `yarn`."
},
"spfx-toolkit.showServiceIncidentList": {
"title": "Show service health incidents",
"type": "boolean",
"default": true,
"description": "Show the service health incidents in the account view."
},
"spfx-toolkit.showAppsInAppCatalogs": {
"title": "Show apps in app catalogs",
"type": "boolean",
"default": true,
"description": "When set it will load all apps in every app catalog from your tenant."
},
"spfx-toolkit.createNodeVersionFileDefaultValue": {
"title": "Default value for the Node version file option",
"type": "boolean",
"default": false,
"description": "The default value for the new project's setting for creating the Node version file. If checked the default selected value will be YES."
},
"spfx-toolkit.nodeVersionManagerFile": {
"title": "Node version manager file to be used",
"type": "string",
"default": ".nvmrc",
"enum": [
".nvmrc",
".node-version"
],
"description": "The file to be used to store the Node version for the selected Node version manager. Remember that the .node-version file is supported only while using nvs."
},
"spfx-toolkit.projectUpgradeOutputMode": {
"title": "Project upgrade output mode",
"type": "string",
"default": "both",
"enum": [
"both",
"markdown",
"code tour"
],
"description": "Choose the output mode for the project upgrade. You can choose between `both`, `markdown`, or `code tour`."
},
"spfx-toolkit.upgradeShellType": {
"title": "Project upgrade shell type",
"type": "string",
"default": "powershell",
"enum": [
"bash",
"powershell",
"cmd"
],
"description": "Choose the shell type to be used for the upgrade action. You can choose between `bash`, `powershell`, or `cmd`."
},
"spfx-toolkit.projectValidateOutputMode": {
"title": "Project validate output mode",
"type": "string",
"default": "both",
"enum": [
"both",
"markdown",
"code tour"
],
"description": "Choose the output mode for the project validation. You can choose between `both`, `markdown`, or `code tour`."
}
}
},
"icons": {
"spo-m365": {
"description": "Microsoft 365 icon",
"default": {
"fontPath": "./assets/fonts/fabric-icons.woff",
"fontCharacter": "\\ED72"
}
},
"spo-logo": {
"description": "SharePoint Online icon",
"default": {
"fontPath": "./assets/fonts/fabric-icons.woff",
"fontCharacter": "\\ED18"
}
},
"spo-app-list": {
"description": "Tenant-Wide extension list icon",
"default": {
"fontPath": "./assets/fonts/fabric-icons.woff",
"fontCharacter": "\\E31E"
}
},
"spo-app": {
"description": "App icon",
"default": {
"fontPath": "./assets/fonts/fabric-icons.woff",
"fontCharacter": "\\ECDC"
}
},
"m365-warning": {
"description": "Warning icon",
"default": {
"fontPath": "./assets/fonts/fabric-icons.woff",
"fontCharacter": "\\E7BA"
}
},
"m365-health": {
"description": "Health icon",
"default": {
"fontPath": "./assets/fonts/fabric-icons.woff",
"fontCharacter": "\\E95E"
}
},
"entra-id": {
"description": "Entra ID icon",
"default": {
"fontPath": "./assets/fonts/fabric-icons.woff",
"fontCharacter": "\\ED68"
}
}
},
"viewsContainers": {
"activitybar": [
{
"id": "pnp-view",
"title": "SPFx Toolkit",
"icon": "assets/logo-light.svg"
}
]
},
"views": {
"pnp-view": [
{
"id": "pnp-view-account",
"name": "Account"
},
{
"id": "pnp-view-environment",
"name": "App Catalog details",
"when": "pnp.project.isLoggedIn"
},
{
"id": "pnp-view-tasks",
"name": "Tasks",
"when": "pnp.project.isSPFxProject"
},
{
"id": "pnp-view-actions",
"name": "Actions"
},
{
"id": "pnp-view-help",
"name": "Help and feedback"
}
]
},
"commands": [
{
"command": "spfx-toolkit.welcome",
"title": "Welcome",
"category": "SPFx Toolkit"
},
{
"command": "spfx-toolkit.checkDependencies",
"title": "Validate local setup",
"category": "SPFx Toolkit"
},