File size: 58,914 Bytes
064bfd6 | 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 | import { z } from 'zod/v4'
import { HooksSchema } from '../../schemas/hooks.js'
import { McpServerConfigSchema } from '../../services/mcp/types.js'
import { lazySchema } from '../lazySchema.js'
/**
* First-layer defense against official marketplace impersonation.
*
* This validation blocks direct impersonation attempts like "anthropic-official",
* "claude-marketplace", etc. Indirect variations (e.g., "my-claude-marketplace")
* are not blocked intentionally to avoid false positives on legitimate names.
* Source org verification provides additional protection at registration/install time.
*/
/**
* Official marketplace names that are reserved for Anthropic/Claude official use.
* These names are allowed ONLY for official marketplaces and blocked for third parties.
*/
export const ALLOWED_OFFICIAL_MARKETPLACE_NAMES = new Set([
'claude-code-marketplace',
'claude-code-plugins',
'claude-plugins-official',
'anthropic-marketplace',
'anthropic-plugins',
'agent-skills',
'life-sciences',
'knowledge-work-plugins',
])
/**
* Official marketplaces that should NOT auto-update by default.
* These are still reserved/allowed names, but opt out of the auto-update
* default that other official marketplaces receive.
*/
const NO_AUTO_UPDATE_OFFICIAL_MARKETPLACES = new Set(['knowledge-work-plugins'])
/**
* Check if auto-update is enabled for a marketplace.
* Uses the stored value if set, otherwise defaults based on whether
* it's an official Anthropic marketplace (true) or not (false).
* Official marketplaces in NO_AUTO_UPDATE_OFFICIAL_MARKETPLACES are excluded
* from the auto-update default.
*
* @param marketplaceName - The name of the marketplace
* @param entry - The marketplace entry (may have autoUpdate set)
* @returns Whether auto-update is enabled for this marketplace
*/
export function isMarketplaceAutoUpdate(
marketplaceName: string,
entry: { autoUpdate?: boolean },
): boolean {
const normalizedName = marketplaceName.toLowerCase()
return (
entry.autoUpdate ??
(ALLOWED_OFFICIAL_MARKETPLACE_NAMES.has(normalizedName) &&
!NO_AUTO_UPDATE_OFFICIAL_MARKETPLACES.has(normalizedName))
)
}
/**
* Pattern to detect names that impersonate official Anthropic/Claude marketplaces.
*
* Matches names containing variations like:
* - "official" combined with "anthropic" or "claude" (e.g., "official-claude-plugins")
* - "anthropic" or "claude" combined with "official" (e.g., "claude-official")
* - Names starting with "anthropic" or "claude" followed by official-sounding terms
* like "marketplace", "plugins" (e.g., "anthropic-marketplace-new", "claude-plugins-v2")
*
* The pattern is case-insensitive.
*/
export const BLOCKED_OFFICIAL_NAME_PATTERN =
/(?:official[^a-z0-9]*(anthropic|claude)|(?:anthropic|claude)[^a-z0-9]*official|^(?:anthropic|claude)[^a-z0-9]*(marketplace|plugins|official))/i
/**
* Pattern to detect non-ASCII characters that could be used for homograph attacks.
* Marketplace names should only contain ASCII characters to prevent impersonation
* via lookalike Unicode characters (e.g., Cyrillic 'Π°' instead of Latin 'a').
*/
const NON_ASCII_PATTERN = /[^\u0020-\u007E]/
/**
* Check if a marketplace name impersonates an official Anthropic/Claude marketplace.
*
* @param name - The marketplace name to check
* @returns true if the name is blocked (impersonates official), false if allowed
*/
export function isBlockedOfficialName(name: string): boolean {
// If it's in the allowed list, it's not blocked
if (ALLOWED_OFFICIAL_MARKETPLACE_NAMES.has(name.toLowerCase())) {
return false
}
// Block names with non-ASCII characters to prevent homograph attacks
// (e.g., using Cyrillic 'Π°' to impersonate 'anthropic')
if (NON_ASCII_PATTERN.test(name)) {
return true
}
// Check if it matches the blocked pattern
return BLOCKED_OFFICIAL_NAME_PATTERN.test(name)
}
/**
* The official GitHub organization for Anthropic marketplaces.
* Reserved names must come from this org.
*/
export const OFFICIAL_GITHUB_ORG = 'anthropics'
/**
* Validate that a marketplace with a reserved name comes from the official source.
*
* Reserved names (in ALLOWED_OFFICIAL_MARKETPLACE_NAMES) can only be used by
* marketplaces from the official Anthropic GitHub organization.
*
* @param name - The marketplace name
* @param source - The marketplace source configuration
* @returns An error message if validation fails, or null if valid
*/
export function validateOfficialNameSource(
name: string,
source: { source: string; repo?: string; url?: string },
): string | null {
const normalizedName = name.toLowerCase()
// Only validate reserved names
if (!ALLOWED_OFFICIAL_MARKETPLACE_NAMES.has(normalizedName)) {
return null // Not a reserved name, no source validation needed
}
// Check for GitHub source type
if (source.source === 'github') {
// Verify the repo is from the official org
const repo = source.repo || ''
if (!repo.toLowerCase().startsWith(`${OFFICIAL_GITHUB_ORG}/`)) {
return `The name '${name}' is reserved for official Anthropic marketplaces. Only repositories from 'github.com/${OFFICIAL_GITHUB_ORG}/' can use this name.`
}
return null // Valid: reserved name from official GitHub source
}
// Check for git URL source type
if (source.source === 'git' && source.url) {
const url = source.url.toLowerCase()
// Check for HTTPS URL format: https://github.com/anthropics/...
// or SSH format: git@github.com:anthropics/...
const isHttpsAnthropics = url.includes('github.com/anthropics/')
const isSshAnthropics = url.includes('git@github.com:anthropics/')
if (isHttpsAnthropics || isSshAnthropics) {
return null // Valid: reserved name from official git URL
}
return `The name '${name}' is reserved for official Anthropic marketplaces. Only repositories from 'github.com/${OFFICIAL_GITHUB_ORG}/' can use this name.`
}
// Reserved names must come from GitHub (either 'github' or 'git' source)
return `The name '${name}' is reserved for official Anthropic marketplaces and can only be used with GitHub sources from the '${OFFICIAL_GITHUB_ORG}' organization.`
}
/**
* Schema for relative file paths that must start with './'
*/
const RelativePath = lazySchema(() => z.string().startsWith('./'))
/**
* Schema for relative paths to JSON files
*/
const RelativeJSONPath = lazySchema(() => RelativePath().endsWith('.json'))
/**
* Schema for MCPB (MCP Bundle) file paths
* Supports both local relative paths and remote URLs
*/
const McpbPath = lazySchema(() =>
z.union([
RelativePath()
.refine(path => path.endsWith('.mcpb') || path.endsWith('.dxt'), {
message: 'MCPB file path must end with .mcpb or .dxt',
})
.describe('Path to MCPB file relative to plugin root'),
z
.string()
.url()
.refine(url => url.endsWith('.mcpb') || url.endsWith('.dxt'), {
message: 'MCPB URL must end with .mcpb or .dxt',
})
.describe('URL to MCPB file'),
]),
)
/**
* Schema for relative paths to Markdown files
*/
const RelativeMarkdownPath = lazySchema(() => RelativePath().endsWith('.md'))
/**
* Schema for relative paths to command sources (markdown files or directories containing SKILL.md)
*/
const RelativeCommandPath = lazySchema(() =>
z.union([
RelativeMarkdownPath(),
RelativePath(), // Allow any relative path, including directories
]),
)
/**
* Shared marketplace-name validation. Used by both PluginMarketplaceSchema
* (validates fetched marketplace.json) and the settings arm of
* MarketplaceSourceSchema (validates inline names in settings.json).
*
* The two must stay in sync: loadAndCacheMarketplace's case 'settings' writes
* to join(cacheDir, source.name) BEFORE the post-write PluginMarketplaceSchema
* validation runs. Any name that passes the settings arm but fails
* PluginMarketplaceSchema leaves orphaned files in the cache (cleanupNeeded=false).
* A single shared schema makes drift impossible.
*/
const MarketplaceNameSchema = lazySchema(() =>
z
.string()
.min(1, 'Marketplace must have a name')
.refine(name => !name.includes(' '), {
message:
'Marketplace name cannot contain spaces. Use kebab-case (e.g., "my-marketplace")',
})
.refine(
name =>
!name.includes('/') &&
!name.includes('\\') &&
!name.includes('..') &&
name !== '.',
{
message:
'Marketplace name cannot contain path separators (/ or \\), ".." sequences, or be "."',
},
)
.refine(name => !isBlockedOfficialName(name), {
message:
'Marketplace name impersonates an official Anthropic/Claude marketplace',
})
.refine(name => name.toLowerCase() !== 'inline', {
message:
'Marketplace name "inline" is reserved for --plugin-dir session plugins',
})
.refine(name => name.toLowerCase() !== 'builtin', {
message: 'Marketplace name "builtin" is reserved for built-in plugins',
}),
)
/**
* Schema for plugin author information
*/
export const PluginAuthorSchema = lazySchema(() =>
z.object({
name: z
.string()
.min(1, 'Author name cannot be empty')
.describe('Display name of the plugin author or organization'),
email: z
.string()
.optional()
.describe('Contact email for support or feedback'),
url: z
.string()
.optional()
.describe('Website, GitHub profile, or organization URL'),
}),
)
/**
* Metadata part of the plugin manifest file (plugin.json)
*
* This schema validates the structure of plugin manifests and provides
* runtime type checking when loading plugins from disk.
*/
const PluginManifestMetadataSchema = lazySchema(() =>
z.object({
name: z
.string()
.min(1, 'Plugin name cannot be empty')
.refine(name => !name.includes(' '), {
message:
'Plugin name cannot contain spaces. Use kebab-case (e.g., "my-plugin")',
})
.describe(
'Unique identifier for the plugin, used for namespacing (prefer kebab-case)',
),
version: z
.string()
.optional()
.describe(
'Semantic version (e.g., 1.2.3) following semver.org specification',
),
description: z
.string()
.optional()
.describe('Brief, user-facing explanation of what the plugin provides'),
author: PluginAuthorSchema()
.optional()
.describe('Information about the plugin creator or maintainer'),
homepage: z
.string()
.url()
.optional()
.describe('Plugin homepage or documentation URL'),
repository: z.string().optional().describe('Source code repository URL'),
license: z
.string()
.optional()
.describe('SPDX license identifier (e.g., MIT, Apache-2.0)'),
keywords: z
.array(z.string())
.optional()
.describe('Tags for plugin discovery and categorization'),
dependencies: z
.array(DependencyRefSchema())
.optional()
.describe(
'Plugins that must be enabled for this plugin to function. Bare names (no "@marketplace") are resolved against the declaring plugin\'s own marketplace.',
),
}),
)
/**
* Schema for plugin hooks configuration (hooks.json)
*
* Defines the hooks that a plugin can provide to intercept and modify
* Claude Code behavior at various lifecycle events.
*/
export const PluginHooksSchema = lazySchema(() =>
z.object({
description: z
.string()
.optional()
.describe('Brief, user-facing explanation of what these hooks provide'),
hooks: z
.lazy(() => HooksSchema())
.describe(
'The hooks provided by the plugin, in the same format as the one used for settings',
),
}),
)
/**
* Schema for additional hooks configuration in plugin manifest
*
* Allows plugins to specify hooks either inline or via external files,
* supplementing any hooks defined in the standard hooks/hooks.json location.
*/
const PluginManifestHooksSchema = lazySchema(() =>
z.object({
hooks: z.union([
RelativeJSONPath().describe(
'Path to file with additional hooks (in addition to those in hooks/hooks.json, if it exists), relative to the plugin root',
),
z
.lazy(() => HooksSchema())
.describe(
'Additional hooks (in addition to those in hooks/hooks.json, if it exists)',
),
z.array(
z.union([
RelativeJSONPath().describe(
'Path to file with additional hooks (in addition to those in hooks/hooks.json, if it exists), relative to the plugin root',
),
z
.lazy(() => HooksSchema())
.describe(
'Additional hooks (in addition to those in hooks/hooks.json, if it exists)',
),
]),
),
]),
}),
)
/**
* Schema for command metadata when using object-mapping format
*
* Allows marketplace entries to provide rich metadata for commands including
* custom descriptions and frontmatter overrides.
*
* Commands can be defined with either:
* - source: Path to a markdown file
* - content: Inline markdown content
*/
export const CommandMetadataSchema = lazySchema(() =>
z
.object({
source: RelativeCommandPath()
.optional()
.describe('Path to command markdown file, relative to plugin root'),
content: z
.string()
.optional()
.describe('Inline markdown content for the command'),
description: z
.string()
.optional()
.describe('Command description override'),
argumentHint: z
.string()
.optional()
.describe('Hint for command arguments (e.g., "[file]")'),
model: z.string().optional().describe('Default model for this command'),
allowedTools: z
.array(z.string())
.optional()
.describe('Tools allowed when command runs'),
})
.refine(
data => (data.source && !data.content) || (!data.source && data.content),
{
message:
'Command must have either "source" (file path) or "content" (inline markdown), but not both',
},
),
)
/**
* Schema for additional command definitions in plugin manifest
*
* Allows plugins to specify extra command files or skill directories beyond those
* in the standard commands/ directory.
*
* Supports three formats:
* 1. Single path: "./README.md"
* 2. Array of paths: ["./README.md", "./docs/guide.md"]
* 3. Object mapping: { "about": { "source": "./README.md", "description": "..." } }
*/
const PluginManifestCommandsSchema = lazySchema(() =>
z.object({
commands: z.union([
// TODO (future work): allow globs?
RelativeCommandPath().describe(
'Path to additional command file or skill directory (in addition to those in the commands/ directory, if it exists), relative to the plugin root',
),
z
.array(
RelativeCommandPath().describe(
'Path to additional command file or skill directory (in addition to those in the commands/ directory, if it exists), relative to the plugin root',
),
)
.describe(
'List of paths to additional command files or skill directories',
),
z
.record(z.string(), CommandMetadataSchema())
.describe(
'Object mapping of command names to their metadata and source files. Command name becomes the slash command name (e.g., "about" β "/plugin:about")',
),
]),
}),
)
/**
* Schema for additional agent definitions in plugin manifest
*
* Allows plugins to specify extra agent files beyond those in the
* standard agents/ directory.
*/
const PluginManifestAgentsSchema = lazySchema(() =>
z.object({
agents: z.union([
// TODO (future work): allow globs?
RelativeMarkdownPath().describe(
'Path to additional agent file (in addition to those in the agents/ directory, if it exists), relative to the plugin root',
),
z
.array(
RelativeMarkdownPath().describe(
'Path to additional agent file (in addition to those in the agents/ directory, if it exists), relative to the plugin root',
),
)
.describe('List of paths to additional agent files'),
]),
}),
)
/**
* Schema for additional skill definitions in plugin manifest
*
* Allows plugins to specify extra skill directories beyond those in the
* standard skills/ directory.
*/
const PluginManifestSkillsSchema = lazySchema(() =>
z.object({
skills: z.union([
RelativePath().describe(
'Path to additional skill directory (in addition to those in the skills/ directory, if it exists), relative to the plugin root',
),
z
.array(
RelativePath().describe(
'Path to additional skill directory (in addition to those in the skills/ directory, if it exists), relative to the plugin root',
),
)
.describe('List of paths to additional skill directories'),
]),
}),
)
/**
* Schema for additional output style definitions in plugin manifest
*
* Allows plugins to specify extra output style files or directories beyond those in the
* standard output-styles/ directory.
*/
const PluginManifestOutputStylesSchema = lazySchema(() =>
z.object({
outputStyles: z.union([
RelativePath().describe(
'Path to additional output styles directory or file (in addition to those in the output-styles/ directory, if it exists), relative to the plugin root',
),
z
.array(
RelativePath().describe(
'Path to additional output styles directory or file (in addition to those in the output-styles/ directory, if it exists), relative to the plugin root',
),
)
.describe(
'List of paths to additional output styles directories or files',
),
]),
}),
)
// Helper validators for LSP config
const nonEmptyString = lazySchema(() => z.string().min(1))
const fileExtension = lazySchema(() =>
z
.string()
.min(2)
.refine(ext => ext.startsWith('.'), {
message: 'File extensions must start with dot (e.g., ".ts", not "ts")',
}),
)
/**
* Schema for MCP server configurations in plugin manifest
*
* Allows plugins to provide MCP servers either inline or via external
* configuration files, supplementing any servers in .mcp.json.
*/
const PluginManifestMcpServerSchema = lazySchema(() =>
z.object({
mcpServers: z.union([
RelativeJSONPath().describe(
'MCP servers to include in the plugin (in addition to those in the .mcp.json file, if it exists)',
),
McpbPath().describe(
'Path or URL to MCPB file containing MCP server configuration',
),
z
.record(z.string(), McpServerConfigSchema())
.describe('MCP server configurations keyed by server name'),
z
.array(
z.union([
RelativeJSONPath().describe(
'Path to MCP servers configuration file',
),
McpbPath().describe('Path or URL to MCPB file'),
z
.record(z.string(), McpServerConfigSchema())
.describe('Inline MCP server configurations'),
]),
)
.describe(
'Array of MCP server configurations (paths, MCPB files, or inline definitions)',
),
]),
}),
)
/**
* Schema for a single user-configurable option in plugin manifest userConfig.
*
* Shape intentionally matches `McpbUserConfigurationOption` from
* `@anthropic-ai/mcpb` so the parsed result is structurally assignable to
* `UserConfigSchema` in mcpbHandler.ts β this lets us reuse
* `validateUserConfig` and the config dialog without modification.
* `title` and `description` are required (not optional) because the upstream
* type requires them and the config dialog renders them.
*
* Used by both the top-level manifest.userConfig and the per-channel
* channels[].userConfig (assistant-mode channels).
*/
const PluginUserConfigOptionSchema = lazySchema(() =>
z
.object({
type: z
.enum(['string', 'number', 'boolean', 'directory', 'file'])
.describe('Type of the configuration value'),
title: z
.string()
.describe('Human-readable label shown in the config dialog'),
description: z
.string()
.describe('Help text shown beneath the field in the config dialog'),
required: z
.boolean()
.optional()
.describe('If true, validation fails when this field is empty'),
default: z
.union([z.string(), z.number(), z.boolean(), z.array(z.string())])
.optional()
.describe('Default value used when the user provides nothing'),
multiple: z
.boolean()
.optional()
.describe('For string type: allow an array of strings'),
sensitive: z
.boolean()
.optional()
.describe(
'If true, masks dialog input and stores value in secure storage (keychain/credentials file) instead of settings.json',
),
min: z.number().optional().describe('Minimum value (number type only)'),
max: z.number().optional().describe('Maximum value (number type only)'),
})
.strict(),
)
/**
* Schema for the top-level userConfig field in plugin manifest.
*
* Declares user-configurable values the plugin needs. Users are prompted at
* enable time. Non-sensitive values go to settings.json
* pluginConfigs[pluginId].options; sensitive values go to secure storage.
* Values are available as ${user_config.KEY} in MCP/LSP server config, hook
* commands, and (non-sensitive only) skill/agent content.
*/
const PluginManifestUserConfigSchema = lazySchema(() =>
z.object({
userConfig: z
.record(
z
.string()
.regex(
/^[A-Za-z_]\w*$/,
'Option keys must be valid identifiers (letters, digits, underscore; no leading digit) β they become CLAUDE_PLUGIN_OPTION_<KEY> env vars in hooks',
),
PluginUserConfigOptionSchema(),
)
.optional()
.describe(
'User-configurable values this plugin needs. Prompted at enable time. ' +
'Non-sensitive values saved to settings.json; sensitive values to secure storage ' +
'(macOS keychain or .credentials.json). Available as ${user_config.KEY} in ' +
'MCP/LSP server config, hook commands, and (non-sensitive only) skill/agent content. ' +
'Note: sensitive values share a single keychain entry with OAuth tokens β keep ' +
'secret counts small to stay under the ~2KB stdin-safe limit (see INC-3028).',
),
}),
)
/**
* Schema for channel declarations in plugin manifest.
*
* A channel is an MCP server that emits `notifications/claude/channel` to
* inject messages into the conversation (Telegram, Slack, Discord, etc.).
* Declaring it here lets the plugin prompt for user config (bot tokens,
* owner IDs) at install time via the PluginOptionsFlow prompt,
* rather than requiring users to hand-edit settings.json.
*
* The `server` field must match a key in the plugin's `mcpServers` β this is
* not cross-validated at schema parse time (the mcpServers field can be a
* path to a JSON file we haven't read yet), so the check happens at load
* time in mcpPluginIntegration.ts instead.
*/
const PluginManifestChannelsSchema = lazySchema(() =>
z.object({
channels: z
.array(
z
.object({
server: z
.string()
.min(1)
.describe(
"Name of the MCP server this channel binds to. Must match a key in this plugin's mcpServers.",
),
displayName: z
.string()
.optional()
.describe(
'Human-readable name shown in the config dialog title (e.g., "Telegram"). Defaults to the server name.',
),
userConfig: z
.record(z.string(), PluginUserConfigOptionSchema())
.optional()
.describe(
'Fields to prompt the user for when enabling this plugin in assistant mode. ' +
'Saved values are substituted into ${user_config.KEY} references in the mcpServers env.',
),
})
.strict(),
)
.describe(
'Channels this plugin provides. Each entry declares an MCP server as a message channel ' +
'and optionally specifies user configuration to prompt for at enable time.',
),
}),
)
/**
* Schema for individual LSP server configuration.
*/
export const LspServerConfigSchema = lazySchema(() =>
z.strictObject({
command: z
.string()
.min(1)
.refine(
cmd => {
// Commands with spaces should use args array instead
if (cmd.includes(' ') && !cmd.startsWith('/')) {
return false
}
return true
},
{
message:
'Command should not contain spaces. Use args array for arguments.',
},
)
.describe(
'Command to execute the LSP server (e.g., "typescript-language-server")',
),
args: z
.array(nonEmptyString())
.optional()
.describe('Command-line arguments to pass to the server'),
extensionToLanguage: z
.record(fileExtension(), nonEmptyString())
.refine(record => Object.keys(record).length > 0, {
message: 'extensionToLanguage must have at least one mapping',
})
.describe(
'Mapping from file extension to LSP language ID. File extensions and languages are derived from this mapping.',
),
transport: z
.enum(['stdio', 'socket'])
.default('stdio')
.describe('Communication transport mechanism'),
env: z
.record(z.string(), z.string())
.optional()
.describe('Environment variables to set when starting the server'),
initializationOptions: z
.unknown()
.optional()
.describe(
'Initialization options passed to the server during initialization',
),
settings: z
.unknown()
.optional()
.describe(
'Settings passed to the server via workspace/didChangeConfiguration',
),
workspaceFolder: z
.string()
.optional()
.describe('Workspace folder path to use for the server'),
startupTimeout: z
.number()
.int()
.positive()
.optional()
.describe('Maximum time to wait for server startup (milliseconds)'),
shutdownTimeout: z
.number()
.int()
.positive()
.optional()
.describe('Maximum time to wait for graceful shutdown (milliseconds)'),
restartOnCrash: z
.boolean()
.optional()
.describe('Whether to restart the server if it crashes'),
maxRestarts: z
.number()
.int()
.nonnegative()
.optional()
.describe('Maximum number of restart attempts before giving up'),
}),
)
/**
* Schema for LSP server declarations in plugin manifest.
* Supports multiple formats:
* - String: path to .lsp.json file
* - Object: inline server configs { "serverName": {...} }
* - Array: mix of strings and objects
*/
const PluginManifestLspServerSchema = lazySchema(() =>
z.object({
lspServers: z.union([
RelativeJSONPath().describe(
'Path to .lsp.json configuration file relative to plugin root',
),
z
.record(z.string(), LspServerConfigSchema())
.describe('LSP server configurations keyed by server name'),
z
.array(
z.union([
RelativeJSONPath().describe('Path to LSP configuration file'),
z
.record(z.string(), LspServerConfigSchema())
.describe('Inline LSP server configurations'),
]),
)
.describe(
'Array of LSP server configurations (paths or inline definitions)',
),
]),
}),
)
/**
* Schema for npm package names
*
* Validates npm package names including scoped packages.
* Prevents path traversal attacks by disallowing '..' and '//'.
*
* Valid examples:
* - "express"
* - "@babel/core"
* - "lodash.debounce"
*
* Invalid examples:
* - "../../../etc/passwd"
* - "package//name"
*/
const NpmPackageNameSchema = lazySchema(() =>
z
.string()
.refine(
name => !name.includes('..') && !name.includes('//'),
'Package name cannot contain path traversal patterns',
)
.refine(name => {
// Allow scoped packages (@org/package) and regular packages
const scopedPackageRegex = /^@[a-z0-9][a-z0-9-._]*\/[a-z0-9][a-z0-9-._]*$/
const regularPackageRegex = /^[a-z0-9][a-z0-9-._]*$/
return scopedPackageRegex.test(name) || regularPackageRegex.test(name)
}, 'Invalid npm package name format'),
)
/**
* Schema for plugin settings that get merged into the settings cascade.
* Accepts any record here; filtering to allowlisted keys happens at load time
* in pluginLoader.ts via PluginSettingsSchema (derived from SettingsSchema).
*/
const PluginManifestSettingsSchema = lazySchema(() =>
z.object({
settings: z
.record(z.string(), z.unknown())
.optional()
.describe(
'Settings to merge when plugin is enabled. ' +
'Only allowlisted keys are kept (currently: agent)',
),
}),
)
/**
* Plugin manifest file (plugin.json)
*
* This schema validates the structure of plugin manifests and provides
* runtime type checking when loading plugins from disk.
*
* Unknown top-level fields are silently stripped (zod default) rather than
* rejected. This keeps plugin loading resilient to custom/future top-level
* fields that plugin authors may add. Nested config objects (userConfig
* options, channels, lspServers) remain strict β unknown keys inside those
* still fail, since a typo there is more likely to be an author mistake
* than a vendor extension. Type mismatches and other validation errors
* still fail at all levels. For developer feedback on unknown top-level
* fields, use `claude plugin validate`.
*/
export const PluginManifestSchema = lazySchema(() =>
z.object({
...PluginManifestMetadataSchema().shape,
...PluginManifestHooksSchema().partial().shape,
...PluginManifestCommandsSchema().partial().shape,
...PluginManifestAgentsSchema().partial().shape,
...PluginManifestSkillsSchema().partial().shape,
...PluginManifestOutputStylesSchema().partial().shape,
...PluginManifestChannelsSchema().partial().shape,
...PluginManifestMcpServerSchema().partial().shape,
...PluginManifestLspServerSchema().partial().shape,
...PluginManifestSettingsSchema().partial().shape,
...PluginManifestUserConfigSchema().partial().shape,
}),
)
/**
* Schema for marketplace source locations
*
* Defines various ways to reference marketplace manifests including
* direct URLs, GitHub repos, git URLs, npm packages, and local paths.
*/
export const MarketplaceSourceSchema = lazySchema(() =>
z.discriminatedUnion('source', [
z.object({
source: z.literal('url'),
url: z.string().url().describe('Direct URL to marketplace.json file'),
headers: z
.record(z.string(), z.string())
.optional()
.describe('Custom HTTP headers (e.g., for authentication)'),
}),
z.object({
source: z.literal('github'),
repo: z.string().describe('GitHub repository in owner/repo format'),
ref: z
.string()
.optional()
.describe(
'Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.',
),
path: z
.string()
.optional()
.describe(
'Path to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)',
),
sparsePaths: z
.array(z.string())
.optional()
.describe(
'Directories to include via git sparse-checkout (cone mode). ' +
'Use for monorepos where the marketplace lives in a subdirectory. ' +
'Example: [".claude-plugin", "plugins"]. ' +
'If omitted, the full repository is cloned.',
),
}),
z.object({
source: z.literal('git'),
// No .endsWith('.git') here β that's a GitHub/GitLab/Bitbucket
// convention, not a git requirement. Azure DevOps uses
// https://dev.azure.com/{org}/{proj}/_git/{repo} with no suffix, and
// appending .git makes ADO look for a repo literally named {repo}.git
// (TF401019). AWS CodeCommit also omits the suffix. If the user
// explicitly wrote source:'git', they know it's a git repo; a typo'd
// URL fails at `git clone` with a clearer error anyway. (gh-31256)
url: z.string().describe('Full git repository URL'),
ref: z
.string()
.optional()
.describe(
'Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.',
),
path: z
.string()
.optional()
.describe(
'Path to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)',
),
sparsePaths: z
.array(z.string())
.optional()
.describe(
'Directories to include via git sparse-checkout (cone mode). ' +
'Use for monorepos where the marketplace lives in a subdirectory. ' +
'Example: [".claude-plugin", "plugins"]. ' +
'If omitted, the full repository is cloned.',
),
}),
z.object({
source: z.literal('npm'),
package: NpmPackageNameSchema().describe(
'NPM package containing marketplace.json',
),
}),
z.object({
source: z.literal('file'),
path: z.string().describe('Local file path to marketplace.json'),
}),
z.object({
source: z.literal('directory'),
path: z
.string()
.describe('Local directory containing .claude-plugin/marketplace.json'),
}),
z.object({
source: z.literal('hostPattern'),
hostPattern: z
.string()
.describe(
'Regex pattern to match the host/domain extracted from any marketplace source type. ' +
'For github sources, matches against "github.com". For git sources (SSH or HTTPS), ' +
'extracts the hostname from the URL. Use in strictKnownMarketplaces to allow all ' +
'marketplaces from a specific host (e.g., "^github\\.mycompany\\.com$").',
),
}),
z.object({
source: z.literal('pathPattern'),
pathPattern: z
.string()
.describe(
'Regex pattern matched against the .path field of file and directory sources. ' +
'Use in strictKnownMarketplaces to allow filesystem-based marketplaces alongside ' +
'hostPattern restrictions for network sources. Use ".*" to allow all filesystem ' +
'paths, or a narrower pattern (e.g., "^/opt/approved/") to restrict to specific ' +
'directories.',
),
}),
z
.object({
source: z.literal('settings'),
name: MarketplaceNameSchema()
.refine(
name => !ALLOWED_OFFICIAL_MARKETPLACE_NAMES.has(name.toLowerCase()),
{
message:
'Reserved official marketplace names cannot be used with settings sources. ' +
'validateOfficialNameSource only accepts github/git sources from anthropics/* ' +
'for these names; a settings source would be rejected after ' +
'loadAndCacheMarketplace has already written to disk with cleanupNeeded=false.',
},
)
.describe(
'Marketplace name. Must match the extraKnownMarketplaces key (enforced); ' +
'the synthetic manifest is written under this name. Same validation ' +
'as PluginMarketplaceSchema plus reserved-name rejection \u2014 ' +
'validateOfficialNameSource runs after the disk write, too late to clean up.',
),
plugins: z
.array(SettingsMarketplacePluginSchema())
.describe('Plugin entries declared inline in settings.json'),
owner: PluginAuthorSchema().optional(),
})
.describe(
'Inline marketplace manifest defined directly in settings.json. ' +
'The reconciler writes a synthetic marketplace.json to the cache; ' +
'diffMarketplaces detects edits via isEqual on the stored source ' +
'(the plugins array is inside this object, so edits surface as sourceChanged).',
),
]),
)
export const gitSha = lazySchema(() =>
z
.string()
.length(40)
.regex(
/^[a-f0-9]{40}$/,
'Must be a full 40-character lowercase git commit SHA',
),
)
/**
* Schema for plugin source locations
*
* Defines various ways to reference and install plugins including
* local paths, npm packages, Python packages, git URLs, and GitHub repos.
*/
export const PluginSourceSchema = lazySchema(() =>
z.union([
RelativePath().describe(
'Path to the plugin root, relative to the marketplace root (the directory containing .claude-plugin/, not .claude-plugin/ itself)',
),
z
.object({
source: z.literal('npm'),
package: NpmPackageNameSchema()
.or(z.string()) // Allow URLs and local paths as well
.describe(
'Package name (or url, or local path, or anything else that can be passed to `npm` as a package)',
),
version: z
.string()
.optional()
.describe('Specific version or version range (e.g., ^1.0.0, ~2.1.0)'),
registry: z
.string()
.url()
.optional()
.describe(
'Custom NPM registry URL (defaults to using system default, likely npmjs.org)',
),
})
.describe('NPM package as plugin source'),
z
.object({
source: z.literal('pip'),
package: z
.string()
.describe('Python package name as it appears on PyPI'),
version: z
.string()
.optional()
.describe('Version specifier (e.g., ==1.0.0, >=2.0.0, <3.0.0)'),
registry: z
.string()
.url()
.optional()
.describe(
'Custom PyPI registry URL (defaults to using system default, likely pypi.org)',
),
})
.describe('Python package as plugin source'),
z.object({
source: z.literal('url'),
// See note on MarketplaceSourceSchema source:'git' re: .endsWith('.git')
// β dropped to support Azure DevOps / CodeCommit URLs (gh-31256).
url: z.string().describe('Full git repository URL (https:// or git@)'),
ref: z
.string()
.optional()
.describe(
'Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.',
),
sha: gitSha().optional().describe('Specific commit SHA to use'),
}),
z.object({
source: z.literal('github'),
repo: z.string().describe('GitHub repository in owner/repo format'),
ref: z
.string()
.optional()
.describe(
'Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.',
),
sha: gitSha().optional().describe('Specific commit SHA to use'),
}),
z
.object({
source: z.literal('git-subdir'),
url: z
.string()
.describe(
'Git repository: GitHub owner/repo shorthand, https://, or git@ URL',
),
path: z
.string()
.min(1)
.describe(
'Subdirectory within the repo containing the plugin (e.g., "tools/claude-plugin"). ' +
'Cloned sparsely using partial clone (--filter=tree:0) to minimize bandwidth for monorepos.',
),
ref: z
.string()
.optional()
.describe(
'Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.',
),
sha: gitSha().optional().describe('Specific commit SHA to use'),
})
.describe(
'Plugin located in a subdirectory of a larger repository (monorepo). ' +
'Only the specified subdirectory is materialized; the rest of the repo is not downloaded.',
),
// TODO (future work) gist
// TODO (future work) single file?
]),
)
/**
* Narrow plugin entry for settings-sourced marketplaces.
*
* Settings-sourced marketplaces point at remote plugins that have their own
* plugin.json β there is no reason to inline commands/agents/hooks/mcp/lsp in
* settings.json. This schema carries only what loadPluginFromMarketplaceEntry
* reads (name, source, version, strict) plus description for discoverability.
*
* The synthetic marketplace.json written by loadAndCacheMarketplace is re-parsed
* with the full PluginMarketplaceSchema, which widens these entries back to
* PluginMarketplaceEntry (strict gets its .default(true), everything else stays
* undefined). So this narrowness is settings-surface-only; downstream code sees
* the same shape it would from any sparse marketplace.json entry.
*
* Keeping this narrow prevents PluginManifestSchema().partial() from expanding
* inline in settingsTypes.generated.ts β that expansion is ~870 lines per
* occurrence, and MarketplaceSource appears three times in the settings schema
* (extraKnownMarketplaces, strictKnownMarketplaces, blockedMarketplaces).
*/
const SettingsMarketplacePluginSchema = lazySchema(() =>
z
.object({
name: z
.string()
.min(1, 'Plugin name cannot be empty')
.refine(name => !name.includes(' '), {
message:
'Plugin name cannot contain spaces. Use kebab-case (e.g., "my-plugin")',
})
.describe('Plugin name as it appears in the target repository'),
source: PluginSourceSchema().describe(
'Where to fetch the plugin from. Must be a remote source β relative ' +
'paths have no marketplace repository to resolve against.',
),
description: z.string().optional(),
version: z.string().optional(),
strict: z.boolean().optional(),
})
.refine(p => typeof p.source !== 'string', {
message:
'Plugins in a settings-sourced marketplace must use remote sources ' +
'(github, git-subdir, npm, url, pip). Relative-path sources like "./foo" ' +
'have no marketplace repository to resolve against.',
}),
)
/**
* Check if a plugin source is a local path (stored in marketplace directory).
*
* Local plugins have their source as a string starting with './' (relative to marketplace).
* External plugins have their source as an object (npm, pip, git, github, etc.).
*
* This function provides a semantic wrapper around the './' prefix check, making
* the intent clear and centralizing the logic for determining plugin source type.
*
* @param source The plugin source from PluginMarketplaceEntry
* @returns true if the source is a local path, false if it's an external source
*/
export function isLocalPluginSource(source: PluginSource): source is string {
return typeof source === 'string' && source.startsWith('./')
}
/**
* Whether a marketplace source points at a user-controlled local filesystem path.
*
* For local sources (`file`/`directory`), `installLocation` IS the user's path β
* it lives outside the plugins cache dir and marketplace operations on it are
* read-only. For remote sources (`github`/`git`/`url`/`npm`), `installLocation`
* is a cache-dir entry managed by Claude Code and subject to rm/re-clone.
*
* Contrast with isLocalPluginSource, which operates on PluginSource (the
* per-plugin source inside a marketplace entry) and checks for `./` prefix.
*/
export function isLocalMarketplaceSource(
source: MarketplaceSource,
): source is Extract<MarketplaceSource, { source: 'file' | 'directory' }> {
return source.source === 'file' || source.source === 'directory'
}
/**
* Schema for individual plugin entries in a marketplace
*
* When strict=true (default): Plugin.json is required, marketplace fields supplement it
* When strict=false: Plugin.json is optional, marketplace provides full manifest
*
* Unknown fields are silently stripped (zod default) rather than rejected.
* Marketplace entries are validated as an array β if one entry rejected
* unknown keys, the whole marketplace.json would fail to parse and ALL
* plugins from that marketplace would become unavailable. Stripping keeps
* the blast radius to zero for custom/future fields.
*/
export const PluginMarketplaceEntrySchema = lazySchema(() =>
PluginManifestSchema()
.partial()
.extend({
name: z
.string()
.min(1, 'Plugin name cannot be empty')
.refine(name => !name.includes(' '), {
message:
'Plugin name cannot contain spaces. Use kebab-case (e.g., "my-plugin")',
})
.describe('Unique identifier matching the plugin name'),
source: PluginSourceSchema().describe('Where to fetch the plugin from'),
category: z
.string()
.optional()
.describe(
'Category for organizing plugins (e.g., "productivity", "development")',
),
tags: z
.array(z.string())
.optional()
.describe('Tags for searchability and discovery'),
strict: z
.boolean()
.optional()
.default(true)
.describe(
'Require the plugin manifest to be present in the plugin folder. If false, the marketplace entry provides the manifest.',
),
}),
)
/**
* Schema for plugin marketplace configuration
*
* Defines the structure for curated collections of plugins that can
* be discovered and installed from a central repository.
*/
export const PluginMarketplaceSchema = lazySchema(() =>
z.object({
name: MarketplaceNameSchema(),
owner: PluginAuthorSchema().describe(
'Marketplace maintainer or curator information',
),
plugins: z
.array(PluginMarketplaceEntrySchema())
.describe('Collection of available plugins in this marketplace'),
forceRemoveDeletedPlugins: z
.boolean()
.optional()
.describe(
'When true, plugins removed from this marketplace will be automatically uninstalled and flagged for users',
),
metadata: z
.object({
pluginRoot: z
.string()
.optional()
.describe('Base path for relative plugin sources'),
version: z.string().optional().describe('Marketplace version'),
description: z.string().optional().describe('Marketplace description'),
})
.optional()
.describe('Optional marketplace metadata'),
allowCrossMarketplaceDependenciesOn: z
.array(z.string())
.optional()
.describe(
"Marketplace names whose plugins may be auto-installed as dependencies. Only the root marketplace's allowlist applies \u2014 no transitive trust.",
),
}),
)
/**
* Schema for plugin ID format
*
* Plugin IDs follow the format: "plugin-name@marketplace-name"
* Both parts allow alphanumeric characters, hyphens, dots, and underscores.
*
* Examples:
* - "code-formatter@anthropic-tools"
* - "db_assistant@company-internal"
* - "my.plugin@personal-marketplace"
*/
export const PluginIdSchema = lazySchema(() =>
z
.string()
.regex(
/^[a-z0-9][-a-z0-9._]*@[a-z0-9][-a-z0-9._]*$/i,
'Plugin ID must be in format: plugin@marketplace',
),
)
const DEP_REF_REGEX =
/^[a-z0-9][-a-z0-9._]*(@[a-z0-9][-a-z0-9._]*)?(@\^[^@]*)?$/i
/**
* Schema for entries in a plugin's `dependencies` array.
*
* Accepts three forms, all normalized to a plain "name" or "name@mkt" string
* by the transform β downstream code (qualifyDependency, resolveDependencyClosure,
* verifyAndDemote) never sees versions or objects:
*
* "plugin" β bare, resolved against declaring plugin's marketplace
* "plugin@marketplace" β qualified
* "plugin@mkt@^1.2" β trailing @^version silently stripped (forwards-compat)
* {name, marketplace?, β¦} β object form, version etc. stripped (forwards-compat)
*
* The latter two are permitted-but-ignored so future clients adding version
* constraints don't cause old clients to fail schema validation and reject
* the whole plugin. See CC-993 for the eventual version-range design.
*/
export const DependencyRefSchema = lazySchema(() =>
z.union([
z
.string()
.regex(
DEP_REF_REGEX,
'Dependency must be a plugin name, optionally qualified with @marketplace',
)
.transform(s => s.replace(/@\^[^@]*$/, '')),
z
.object({
name: z
.string()
.min(1)
.regex(/^[a-z0-9][-a-z0-9._]*$/i),
marketplace: z
.string()
.min(1)
.regex(/^[a-z0-9][-a-z0-9._]*$/i)
.optional(),
})
.loose()
.transform(o => (o.marketplace ? `${o.name}@${o.marketplace}` : o.name)),
]),
)
/**
* Schema for plugin reference in settings (repo or user level)
*
* Can be either:
* - Simple string: "plugin-name@marketplace-name"
* - Object with additional configuration
*
* The plugin source (npm, git, local) is defined in the marketplace entry itself,
* not in the plugin reference.
*
* Examples:
* - "code-formatter@anthropic-tools"
* - "db-assistant@company-internal"
* - { id: "formatter@tools", version: "^2.0.0", required: true }
*/
export const SettingsPluginEntrySchema = lazySchema(() =>
z.union([
// Simple format: "plugin@marketplace"
PluginIdSchema(),
// Extended format with configuration
z.object({
id: PluginIdSchema().describe(
'Plugin identifier (e.g., "formatter@tools")',
),
version: z
.string()
.optional()
.describe('Version constraint (e.g., "^2.0.0")'),
required: z.boolean().optional().describe('If true, cannot be disabled'),
config: z
.record(z.string(), z.unknown())
.optional()
.describe('Plugin-specific configuration'),
}),
]),
)
/**
* Schema for installed plugin metadata (V1 format)
*
* Tracks the actual installation state of a plugin. All plugins are
* installed from marketplaces, which contain the actual source details
* (npm, git, local, etc.). The plugin ID is the key in the plugins record,
* so it's not duplicated here.
*
* Example entry for key "code-formatter@anthropic-tools":
* {
* "version": "1.2.0",
* "installedAt": "2024-01-15T10:30:00Z",
* "marketplace": "anthropic-tools",
* "installPath": "/home/user/.claude/plugins/installed/anthropic-tools/code-formatter"
* }
*/
export const InstalledPluginSchema = lazySchema(() =>
z.object({
version: z.string().describe('Currently installed version'),
installedAt: z.string().describe('ISO 8601 timestamp of installation'),
lastUpdated: z
.string()
.optional()
.describe('ISO 8601 timestamp of last update'),
installPath: z
.string()
.describe('Absolute path to the installed plugin directory'),
gitCommitSha: z
.string()
.optional()
.describe('Git commit SHA for git-based plugins (for version tracking)'),
}),
)
/**
* Schema for the installed_plugins.json file (V1 format)
*
* Contains a version number and maps plugin IDs to their installation metadata.
* Maintained automatically by Claude Code, not edited by users.
*
* The version field tracks schema changes. When the version doesn't match
* the current schema version, Claude Code will update the file on next startup.
*
* Example file:
* {
* "version": 1,
* "plugins": {
* "code-formatter@anthropic-tools": { ... },
* "db-assistant@company-internal": { ... }
* }
* }
*/
export const InstalledPluginsFileSchemaV1 = lazySchema(() =>
z.object({
version: z.literal(1).describe('Schema version 1'),
plugins: z
.record(
PluginIdSchema(), // Validated plugin ID key (e.g., "formatter@tools")
InstalledPluginSchema(),
)
.describe('Map of plugin IDs to their installation metadata'),
}),
)
/**
* Scope types for plugin installation (V2)
*
* Plugins can be installed at different scopes:
* - managed: Enterprise/system-wide (read-only, platform-specific paths)
* - user: User's global settings (~/.claude/settings.json)
* - project: Shared project settings ($project/.claude/settings.json)
* - local: Personal project overrides ($project/.claude/settings.local.json)
*
* Note: 'flag' scope plugins (from --settings) are session-only and
* are NOT persisted to installed_plugins.json.
*/
export const PluginScopeSchema = lazySchema(() =>
z.enum(['managed', 'user', 'project', 'local']),
)
/**
* Schema for a single plugin installation entry (V2)
*
* Each plugin can have multiple installations at different scopes.
* For example, the same plugin could be installed at user scope with v1.0
* and at project scope with v1.1.
*/
export const PluginInstallationEntrySchema = lazySchema(() =>
z.object({
scope: PluginScopeSchema().describe('Installation scope'),
projectPath: z
.string()
.optional()
.describe('Project path (required for project/local scopes)'),
installPath: z
.string()
.describe('Absolute path to the versioned plugin directory'),
// Preserved from V1:
version: z.string().optional().describe('Currently installed version'),
installedAt: z
.string()
.optional()
.describe('ISO 8601 timestamp of installation'),
lastUpdated: z
.string()
.optional()
.describe('ISO 8601 timestamp of last update'),
gitCommitSha: z
.string()
.optional()
.describe('Git commit SHA for git-based plugins'),
}),
)
/**
* Schema for the installed_plugins.json file (V2 format)
*
* V2 changes from V1:
* - Each plugin ID maps to an ARRAY of installations (one per scope)
* - Supports multi-scope installation (same plugin at different scopes/versions)
*
* Example file:
* {
* "version": 2,
* "plugins": {
* "code-formatter@anthropic-tools": [
* { "scope": "user", "installPath": "...", "version": "1.0.0" },
* { "scope": "project", "projectPath": "/path/to/project", "installPath": "...", "version": "1.1.0" }
* ]
* }
* }
*/
export const InstalledPluginsFileSchemaV2 = lazySchema(() =>
z.object({
version: z.literal(2).describe('Schema version 2'),
plugins: z
.record(PluginIdSchema(), z.array(PluginInstallationEntrySchema()))
.describe('Map of plugin IDs to arrays of installation entries'),
}),
)
/**
* Combined schema that accepts both V1 and V2 formats
* Used for reading existing files before migration
*/
export const InstalledPluginsFileSchema = lazySchema(() =>
z.union([InstalledPluginsFileSchemaV1(), InstalledPluginsFileSchemaV2()]),
)
/**
* Schema for a known marketplace entry
*
* Tracks metadata about a registered marketplace in the user's configuration.
* Each entry contains the source location, cache path, and last update time.
*
* Example entry:
* {
* "source": { "source": "github", "repo": "anthropic/claude-plugins" },
* "installLocation": "/home/user/.claude/plugins/cached/marketplaces/anthropic-tools",
* "lastUpdated": "2024-01-15T10:30:00Z"
* }
*/
export const KnownMarketplaceSchema = lazySchema(() =>
z.object({
source: MarketplaceSourceSchema().describe(
'Where to fetch the marketplace from',
),
installLocation: z
.string()
.describe('Local cache path where marketplace manifest is stored'),
lastUpdated: z
.string()
.describe('ISO 8601 timestamp of last marketplace refresh'),
autoUpdate: z
.boolean()
.optional()
.describe(
'Whether to automatically update this marketplace and its installed plugins on startup',
),
}),
)
/**
* Schema for the known_marketplaces.json file
*
* Maps marketplace names to their source and cache metadata.
* Used to track which marketplaces are registered and where to find them.
*
* Example file:
* {
* "anthropic-tools": { "source": { ... }, "installLocation": "...", "lastUpdated": "..." },
* "company-internal": { "source": { ... }, "installLocation": "...", "lastUpdated": "..." }
* }
*/
export const KnownMarketplacesFileSchema = lazySchema(() =>
z.record(
z.string(), // Marketplace name as key
KnownMarketplaceSchema(),
),
)
// Inferred types from schemas
/**
* Metadata for plugin command definitions.
*
* Commands can be defined with either:
* - `source`: Path to a markdown file (e.g., "./README.md")
* - `content`: Inline markdown content string
*
* INVARIANT: Exactly one of `source` or `content` must be present.
* This invariant is enforced at runtime by CommandMetadataSchema validation.
*
* Validation occurs at plugin manifest parsing. Metadata is assumed valid
* after passing through createPluginFromPath().
*
* @see CommandMetadataSchema for runtime validation rules
*/
export type CommandMetadata = z.infer<ReturnType<typeof CommandMetadataSchema>>
export type MarketplaceSource = z.infer<
ReturnType<typeof MarketplaceSourceSchema>
>
export type PluginAuthor = z.infer<ReturnType<typeof PluginAuthorSchema>>
export type PluginSource = z.infer<ReturnType<typeof PluginSourceSchema>>
export type PluginManifest = z.infer<ReturnType<typeof PluginManifestSchema>>
export type PluginManifestChannel = NonNullable<
PluginManifest['channels']
>[number]
export type PluginMarketplace = z.infer<
ReturnType<typeof PluginMarketplaceSchema>
>
export type PluginMarketplaceEntry = z.infer<
ReturnType<typeof PluginMarketplaceEntrySchema>
>
export type PluginId = z.infer<ReturnType<typeof PluginIdSchema>> // string in "plugin@marketplace" format
export type InstalledPlugin = z.infer<ReturnType<typeof InstalledPluginSchema>>
export type InstalledPluginsFileV1 = z.infer<
ReturnType<typeof InstalledPluginsFileSchemaV1>
>
export type InstalledPluginsFileV2 = z.infer<
ReturnType<typeof InstalledPluginsFileSchemaV2>
>
export type PluginScope = z.infer<ReturnType<typeof PluginScopeSchema>>
export type PluginInstallationEntry = z.infer<
ReturnType<typeof PluginInstallationEntrySchema>
>
export type KnownMarketplace = z.infer<
ReturnType<typeof KnownMarketplaceSchema>
>
export type KnownMarketplacesFile = z.infer<
ReturnType<typeof KnownMarketplacesFileSchema>
> // Record<string, KnownMarketplace>
|