|
| 1 | +{ |
| 2 | + "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | + "$id": "https://cursor.com/schemas/cursor-plugin/plugin.json", |
| 4 | + "title": "Cursor Plugin Manifest", |
| 5 | + "description": "Schema for .cursor-plugin/plugin.json — defines a single Cursor plugin's metadata, components, and configuration.", |
| 6 | + "type": "object", |
| 7 | + "required": ["name"], |
| 8 | + "additionalProperties": false, |
| 9 | + "properties": { |
| 10 | + "name": { |
| 11 | + "type": "string", |
| 12 | + "minLength": 1, |
| 13 | + "pattern": "^[a-z0-9]([a-z0-9.-]*[a-z0-9])?$", |
| 14 | + "description": "Unique plugin identifier in kebab-case (lowercase alphanumeric with hyphens and periods)." |
| 15 | + }, |
| 16 | + "displayName": { |
| 17 | + "type": "string", |
| 18 | + "description": "Human-readable display name for the plugin." |
| 19 | + }, |
| 20 | + "description": { |
| 21 | + "type": "string", |
| 22 | + "description": "Short description of what the plugin does." |
| 23 | + }, |
| 24 | + "version": { |
| 25 | + "type": "string", |
| 26 | + "description": "Semantic version of the plugin (e.g. \"1.2.3\")." |
| 27 | + }, |
| 28 | + "author": { |
| 29 | + "$ref": "#/$defs/author", |
| 30 | + "description": "The plugin author." |
| 31 | + }, |
| 32 | + "publisher": { |
| 33 | + "type": "string", |
| 34 | + "minLength": 1, |
| 35 | + "description": "Publisher or organisation name." |
| 36 | + }, |
| 37 | + "homepage": { |
| 38 | + "type": "string", |
| 39 | + "format": "uri", |
| 40 | + "description": "URL to the plugin's homepage." |
| 41 | + }, |
| 42 | + "repository": { |
| 43 | + "type": "string", |
| 44 | + "format": "uri", |
| 45 | + "description": "URL to the plugin's source code repository." |
| 46 | + }, |
| 47 | + "license": { |
| 48 | + "type": "string", |
| 49 | + "description": "SPDX license identifier (e.g. \"MIT\", \"Apache-2.0\")." |
| 50 | + }, |
| 51 | + "logo": { |
| 52 | + "type": "string", |
| 53 | + "description": "Path to a logo image (relative to the plugin root) or an absolute URL." |
| 54 | + }, |
| 55 | + "keywords": { |
| 56 | + "type": "array", |
| 57 | + "items": { "type": "string" }, |
| 58 | + "description": "Keywords for discovery and search." |
| 59 | + }, |
| 60 | + "commands": { |
| 61 | + "$ref": "#/$defs/stringOrStringArray", |
| 62 | + "description": "Glob pattern(s) or path(s) to command files." |
| 63 | + }, |
| 64 | + "agents": { |
| 65 | + "$ref": "#/$defs/stringOrStringArray", |
| 66 | + "description": "Glob pattern(s) or path(s) to agent definition files." |
| 67 | + }, |
| 68 | + "skills": { |
| 69 | + "$ref": "#/$defs/stringOrStringArray", |
| 70 | + "description": "Glob pattern(s) or path(s) to skill files." |
| 71 | + }, |
| 72 | + "rules": { |
| 73 | + "$ref": "#/$defs/stringOrStringArray", |
| 74 | + "description": "Glob pattern(s) or path(s) to rule files." |
| 75 | + }, |
| 76 | + "hooks": { |
| 77 | + "oneOf": [ |
| 78 | + { "type": "string" }, |
| 79 | + { "type": "object" } |
| 80 | + ], |
| 81 | + "description": "Path to a hooks configuration file, or an inline hooks object." |
| 82 | + }, |
| 83 | + "mcpServers": { |
| 84 | + "$ref": "#/$defs/mcpServers", |
| 85 | + "description": "MCP server configuration — a path, an inline config object, or an array of either." |
| 86 | + } |
| 87 | + }, |
| 88 | + "$defs": { |
| 89 | + "author": { |
| 90 | + "type": "object", |
| 91 | + "required": ["name"], |
| 92 | + "additionalProperties": false, |
| 93 | + "properties": { |
| 94 | + "name": { |
| 95 | + "type": "string", |
| 96 | + "minLength": 1, |
| 97 | + "description": "Author name." |
| 98 | + }, |
| 99 | + "email": { |
| 100 | + "type": "string", |
| 101 | + "format": "email", |
| 102 | + "description": "Author email address." |
| 103 | + } |
| 104 | + } |
| 105 | + }, |
| 106 | + "stringOrStringArray": { |
| 107 | + "oneOf": [ |
| 108 | + { "type": "string" }, |
| 109 | + { |
| 110 | + "type": "array", |
| 111 | + "items": { "type": "string" } |
| 112 | + } |
| 113 | + ] |
| 114 | + }, |
| 115 | + "mcpServers": { |
| 116 | + "oneOf": [ |
| 117 | + { "type": "string" }, |
| 118 | + { "type": "object" }, |
| 119 | + { |
| 120 | + "type": "array", |
| 121 | + "items": { |
| 122 | + "oneOf": [ |
| 123 | + { "type": "string" }, |
| 124 | + { "type": "object" } |
| 125 | + ] |
| 126 | + } |
| 127 | + } |
| 128 | + ] |
| 129 | + } |
| 130 | + } |
| 131 | +} |
0 commit comments