Back to Docs
Plugin Fields Reference
Complete reference for all fields in plugin configuration files.
.claude-plugin/plugin.json
The main plugin manifest file. Required for all plugins.
| Field | Type | Req | Description |
|---|---|---|---|
| name | string | Plugin identifier (lowercase, hyphens only) | |
| displayName | string | Human-readable name | |
| version | string | Semantic version | |
| description | string | Short description (max 500 chars) | |
| author | string | Author name or organization | |
| capabilities.skills | string[] | List of skill file names | |
| capabilities.mcp | string[] | List of MCP server names |
integrity.json
Contains SHA-256 hashes of all files for verification. Required.
| Field | Type | Req | Description |
|---|---|---|---|
| version | number | Integrity schema version | |
| generatedAt | string | ISO 8601 timestamp | |
| packageName | string | npm package name | |
| packageVersion | string | Package version | |
| rootHash | string | SHA-256 hash of all file hashes | |
| files | object[] | Array of file entries with path and sha256 |
.mcp.json
MCP server configuration. Optional, only needed if plugin provides MCP servers.
| Field | Type | Req | Description |
|---|---|---|---|
| mcpServers | object | Map of server name to config | |
| mcpServers[name].command | string | Command to run server | |
| mcpServers[name].args | string[] | Command arguments | |
| mcpServers[name].env | object | Environment variables |
MCP commands and args are validated for dangerous patterns (shell operators, sudo, rm -rf, etc.)
Catalog Entry (API Response)
Fields returned by the catalog API for each plugin.
| Field | Type | Req | Description |
|---|---|---|---|
| name | string | Plugin identifier | |
| displayName | string | Display name | |
| description | string | Short description | |
| npm.package | string | npm package name (@claudebase/ scope) | |
| npm.version | string | Current published version | |
| status.visibility | string | public | unlisted | revoked | |
| status.reason | string | Revocation reason if revoked | |
| author.name | string | Author display name | |
| capabilities.skills | string[] | Skill names | |
| capabilities.mcp | string[] | MCP server names | |
| tags | string[] | Categorization tags | |
| categories | string[] | Categories |