Plugin Protocol

Enterprise plugins are described by a YAML manifest. Gateway and the admin policy center both consume it. Source directory: enterprise/plugins/.

Plugin Protocol

Enterprise plugins are described by a YAML manifest. Gateway and the admin policy center both consume it. Source directory: enterprise/plugins/.

Manifest types

type	Purpose	Status
`rule-pack`	Compliance / sensitive-term / PII rules	Implemented (3 moderation packs)
`tool-pack`	Tool-capability extension template	Stub (watermark/doc-review)
`theme-pack`	White-label theme	Stub (theme-default)

rule-pack spec

Top-level fields

yaml

1name: moderation-pii-baseline    # Unique id; extends refers to this name
2version: 0.1.0
3type: rule-pack
4description: Human-readable description
5extends: moderation-pii-baseline  # Optional; inherit another rule-pack (Go loader: single string)
6rules:
7  - id: pii-email
8    kind: pii | keyword | regex
9    action: block | warn | redact
10    severity: critical | high | medium | low
11    message: Copy shown to the user / audit on a hit
12    # Kind-specific fields below

kind: pii

yaml

1kind: pii
2pii_type: email | mobile | id-card | bank-card | api-key

The Go policy-engine ships built-in detectors; redact replaces with a placeholder, block aborts the request.

kind: keyword

yaml

1kind: keyword
2keywords:
3  - keyword-1
4  - keyword-2

kind: regex

yaml

1kind: regex
2pattern: "(?i)regular-expression"

Action semantics

action	Gateway behavior	UI blocked flag
`block`	Abort and return a business error	true
`warn`	Allow; record hits	false
`redact`	Replace the sensitive span and continue	false

Admin policy test POST /api/policy/test: blocked is true only when action=block.

extends inheritance

Example: moderation-finance/manifest.yaml

yaml

1extends: moderation-pii-baseline
2rules:
3  - id: finance-keyword-insider
4    kind: keyword
5    ...

Limits (Go loader):

extends is a single string; an array fails deserialization or keeps only the first item
The inheritance chain merges rules at load time; a child pack may override the same id (as implemented)

Official rule-packs

Directory	extends	Description
`moderation-pii-baseline`	—	Email / mobile / national ID / bank card / API Key
`moderation-finance`	pii-baseline	Finance keywords + regex warn
`moderation-medical`	pii-baseline	Medical PHI keyword warn

Gateway default scan: ../../plugins/moderation-*/manifest.yaml (see apps/gateway/internal/config/config.go).

PG policy vs manifest

Plugins — built-in baseline, shipped with Gateway
Admin policy center — tenant-custom rules written to policy_rules, published into enterprise_runtime_policy_snapshots
Gateway — merges the snapshot + override file and hot-reloads

Customer-specific rules should live in the PG policy center or customers/*/rules/, not in @agenticx/* source.

tool-pack / theme-pack (reserved)

yaml

1name: tool-watermark
2version: 0.1.0
3type: tool-pack
4description: PDF watermark tool template
5# Current manifest is an empty-shell TODO

Implementation roadmap: connect to the Machi tool registry / enterprise tool marketplace. Schema docs will be filled in after the protocol stabilizes.

Customer-defined plugins

Define a rule-pack at customers/<client>/plugins/<name>/manifest.yaml
At deploy time, add the manifest path to Gateway config or import it as an admin policy pack
Follow guides/enterprise-customers-collaboration.md: do not change the enterprise trunk

Related docs

gateway/policy-engine.md — three-channel evaluation
runbooks/policy-snapshot-rollback.md
Admin UI: Policy rule center /policy

Made-with: Damon Li