agent-rules-tool 0.1.0-rc.2

Lint and migrate agent rules per agent-rules-spec
Documentation 
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/rameshsunkara/agent-rules-spec/schema/agent-rule.schema.json",
  "title": "Agent Rule Frontmatter",
  "description": "Schema for validating the YAML frontmatter of structured agent rule files.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "Kebab-case identifier for the rule. Must match the filename stem.",
      "pattern": "^[a-z0-9](-?[a-z0-9])*$",
      "maxLength": 64
    },
    "description": {
      "type": "string",
      "description": "Human-readable summary of what this rule covers. Used by agents to decide relevance.",
      "maxLength": 1024
    },
    "trigger": {
      "type": "string",
      "description": "Activation mode for the rule.",
      "enum": ["always", "auto", "manual"],
      "default": "always"
    },
    "paths": {
      "type": "array",
      "description": "Glob patterns (gitignore-style) for file-scoped activation. When trigger is 'auto', the rule activates when the agent accesses files matching any pattern.",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "keywords": {
      "type": "array",
      "description": "Prompt keywords for activation. When trigger is 'auto', the rule also activates if the user's prompt contains any keyword.",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "priority": {
      "type": "integer",
      "description": "Conflict resolution priority. Higher values take precedence when rules conflict.",
      "minimum": -1000,
      "maximum": 1000,
      "default": 0
    },
    "tags": {
      "type": "array",
      "description": "Organizational grouping tags. No semantic effect -- used for filtering and documentation.",
      "items": {
        "type": "string",
        "pattern": "^[a-z0-9](-?[a-z0-9])*$",
        "maxLength": 64
      },
      "uniqueItems": true
    }
  },
  "if": {
    "properties": {
      "trigger": { "const": "auto" }
    },
    "required": ["trigger"]
  },
  "then": {
    "anyOf": [
      { "required": ["paths"] },
      { "required": ["keywords"] }
    ]
  }
}