Skip to main content

plugin.json reference

Lives at plugins/<name>/.claude-plugin/plugin.json.

{
"name": "acme-billing",
"version": "0.1.0",
"description": "Acme billing — invoices, customers, payments via the Acme REST API.",
"author": { "name": "Your Org" },
"homepage": "https://github.com/mySMB-AI-Studio/mysmb-marketplace/tree/main/plugins/acme-billing",
"license": "MIT",
"keywords": ["acme", "billing", "invoices", "smb"],
"widgets": "widgets",
"widgetElements": "widget-elements/dist/index.js"
}

Fields

FieldRequiredTypeNotes
namestringMust equal the directory name. Lowercase, hyphen-separated.
versionsemverE.g. 0.1.0
descriptionstringOne line.
author{ name: string }Author / org name.
homepagerecommendedURLLink to the plugin folder on GitHub.
licenserecommendedSPDX idUsually "MIT".
keywordsrecommendedstring[]Used for search / discovery.
widgetswhen presentpathDirectory of widget JSON, relative to plugin root. Usually "widgets".
widgetElementswhen presentpathCompiled JS module, relative to plugin root. Usually "widget-elements/dist/index.js".