Roo-Code/schemas/roomodes.json at cfc8a556cf9f2da69d015ddeb122694f2e697c47 · RooCodeInc/Roo-Code · GitHub

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
{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "https://github.com/RooCodeInc/Roo-Code/blob/main/schemas/roomodes.json",
	"title": "Roo Code Custom Modes",
	"description": "Schema for .roomodes configuration files used by Roo Code to define custom modes.",
	"type": "object",
	"required": ["customModes"],
	"additionalProperties": false,
	"properties": {
		"customModes": {
			"type": "array",
			"description": "List of custom mode definitions.",
			"items": {
				"$ref": "#/definitions/CustomMode"
			}
		}
	},
	"definitions": {
		"ToolGroup": {
			"type": "string",
			"enum": ["read", "edit", "command", "mcp", "modes"],
			"description": "A tool group name that grants the mode access to a set of tools."
		},
		"GroupOptions": {
			"type": "object",
			"description": "Options that restrict a tool group's file access.",
			"properties": {
				"fileRegex": {
					"type": "string",
					"description": "A regular expression pattern to restrict which files the tool group can access."
				},
				"description": {
					"type": "string",
					"description": "A human-readable description of the file restriction."
				}
			},
			"additionalProperties": false
		},
		"GroupEntryTuple": {
			"type": "array",
			"description": "A tuple of [toolGroupName, options] for tool groups with file restrictions.",
			"items": [{ "$ref": "#/definitions/ToolGroup" }, { "$ref": "#/definitions/GroupOptions" }],
			"additionalItems": false,
			"minItems": 2,
			"maxItems": 2
		},
		"GroupEntry": {
			"description": "A tool group permission entry. Either a simple tool group name string, or a [toolGroupName, options] tuple for groups with file restrictions.",
			"oneOf": [{ "$ref": "#/definitions/ToolGroup" }, { "$ref": "#/definitions/GroupEntryTuple" }]
		},
		"CustomMode": {
			"type": "object",
			"description": "A custom mode definition.",
			"required": ["slug", "name", "roleDefinition", "groups"],
			"additionalProperties": false,
			"properties": {
				"slug": {
					"type": "string",
					"pattern": "^[a-zA-Z0-9-]+$",
					"description": "A unique identifier for the mode, containing only letters, numbers, and dashes."
				},
				"name": {
					"type": "string",
					"minLength": 1,
					"description": "The display name of the mode."
				},
				"roleDefinition": {
					"type": "string",
					"minLength": 1,
					"description": "The system prompt that defines the mode's role and behavior."
				},
				"whenToUse": {
					"type": "string",
					"description": "A description of when this mode should be used, shown in the mode selection UI."
				},
				"description": {
					"type": "string",
					"description": "A short description of the mode."
				},
				"customInstructions": {
					"type": "string",
					"description": "Additional instructions appended to the system prompt."
				},
				"groups": {
					"type": "array",
					"description": "The tool groups this mode has access to.",
					"items": {
						"$ref": "#/definitions/GroupEntry"
					}
				},
				"source": {
					"type": "string",
					"enum": ["global", "project"],
					"description": "Where this mode was defined. Automatically set by Roo Code."
				}
			}
		}
	}
}