Development Guide

!!! tip 'Start with canonical models' Use canonical types when designing plugin inputs/outputs to ensure compatibility with other plugins and core services.

!!! note 'Admin Console integration' Every plugin must expose administrative UI components when applicable; no CLI-only features.

!!! warning 'Security review required' Plugins that access PHI require additional security review and must declare required roles and capabilities.

Plugin anatomy

• manifest.yaml — metadata and capabilities
• server/ — plugin runtime (Python/Node)
• ui/ — optional Admin UI components
• tests/ — unit and integration tests

Manifest example (conceptual)

Lifecycle

mermaid sequenceDiagram participant Admin participant Plugin participant Core Admin->>Core: register(plugin manifest) Core->>Plugin: initialize Plugin->>Core: register handlers Core->>Admin: plugin registered

Example: plugin registration via API

# (1)
import requests
resp = requests.post('https://admin.example/api/plugins', json={'name': 'my-plugin', 'version':'1.0.0'})
print(resp.json())

// (1)
const fetch = require('node-fetch')
await fetch('https://admin.example/api/plugins', { method: 'POST', body: JSON.stringify({ name: 'my-plugin', version: '1.0.0' }) })

# (1)
curl -X POST https://admin.example/api/plugins -H 'Content-Type: application/json' -d '{"name":"my-plugin","version":"1.0.0"}'

1. Register a plugin manifest with the Admin API; plugin will be initialized and provided with secrets

Development checklist

• Implement canonical adapters if exchanging user/message data
• Provide Admin UI components for configuration
• Add unit and async tests (++pytest++ for Python)
• Submit security review for PHI access

??? note 'Testing' Use in-memory SQLite for tests and avoid network/DB calls at import time. Mark async tests with ++@pytest.mark.asyncio++.

Packaging & Marketplace

!!! danger 'Unsigned plugins' Do not install unsigned plugins in production without an explicit security review.