Marketplace Metadata

ValidatorPluginOfficial docsPlugin marketplaces

The marketplace.json file lives in .claude-plugin/ and defines a plugin catalog for distribution.

Fields

Field	Type	Required	Description
$schema	string	no	Schema URL for IDE validation
name	string	yes	Marketplace name
description	string	no	Marketplace description
version	string	no	Marketplace version
owner	object	yes	Owner info
plugins	array	yes	Array of plugin entries
metadata	object	no	Extra metadata (pluginRoot, etc.)
allowCrossMarketplaceDependenciesOn	string[]	no	Other marketplaces that plugins in this marketplace may depend on. Dependencies from a marketplace not listed here are blocked at install
forceRemoveDeletedPlugins	boolean	no	Uninstall plugins removed from this marketplace catalog
renames	object	no	Map former plugin names to new names, or null for removed plugins

Owner

Field	Type	Required	Description
name	string	yes	Owner name
email	string	no	Contact email

Plugin Entry

Each entry in the plugins array:

Field	Type	Required	Description
name	string	yes	Plugin name
source	string | object	yes	Relative path or source object
description	string	no	Plugin description
version	string	no	Plugin version
author	object	no	Author info (name, email, url)
homepage	string	no	Homepage URL
repository	string	no	Repository URL
license	string	no	License identifier
keywords	string[]	no	Search keywords
category	string	no	Plugin category
tags	string[]	no	Categorization tags
strict	boolean	no	Enable strict mode
displayName	string	no	Human-readable name, overriding the plugin manifest
defaultEnabled	boolean	no	Initial enablement, overriding the plugin manifest
metadata	object	no	Free-form catalog data
relevance	object	no	Plugin recommendation signals
headers	object	no	Headers for archive downloads
headersHelper	string	no	Command printing archive authentication headers

Plugin Source

The source field can be a relative path string or an object:

Field	Type	Required	Description
source	string	yes	github, url, git-subdir, npm, archive, or command
repo	string	no	GitHub owner/repo (for github)
url	string	no	Git URL (for url/git-subdir)
path	string	no	Subdirectory path (for git-subdir)
package	string	no	Package name (for npm)
version	string	no	Version constraint
registry	string	no	Custom registry URL
ref	string	no	Git ref (tag, branch, commit)
sha	string	no	Git commit SHA for pinning
sha256	string	no	Archive integrity pin, 64 hexadecimal characters
command	string	no	For command sources, prints the plugin directory path
timeout	number	no	Command timeout in whole seconds, at most 600
mode	string	no	Command source copy or link mode

Example

A marketplace with one local plugin and one external plugin:

{
  "name": "my-plugins",
  "description": "Plugins for developer tooling.",
  "version": "1.0.0",
  "owner": { "name": "Dev Team", "email": "team@example.com" },
  "metadata": {
    "description": "Plugins for developer tooling."
  },
  "plugins": [
    {
      "name": "my-linter",
      "source": "./",
      "description": "A linter plugin bundled with this marketplace.",
      "version": "1.0.0",
      "author": { "name": "Dev Team" },
      "homepage": "https://example.com",
      "repository": "https://github.com/example/my-linter",
      "license": "MIT",
      "keywords": ["linting", "developer-tools"],
      "category": "developer-tools"
    },
    {
      "name": "external-plugin",
      "source": { "source": "github", "repo": "owner/repo", "ref": "v2.0.0" },
      "description": "An external plugin fetched from GitHub.",
      "category": "developer-tools"
    }
  ]
}