The admin tools
The nine actions on the admin surface. Every call runs as the conversing user and requires the ContextWorks Admin or ContextWorks Domain Manager permission set. Reads return aggregates and configuration, never record data — record data stays on the runtime actions.
Get Catalog
The same action the runtime surface uses — the index, an entity’s full contract, scoped by domain — registered on the admin surface so you can read exactly what an agent receives. Inputs: Invocable actions.
Get Health
How ContextWorks is doing. One area per call.
| Input | Notes |
|---|---|
area | trends (default — this 7 days vs the prior 7, by domain) · usage · quality (entities only) · issues · writes |
domainApiName | Optional: one domain’s traffic |
library | Optional: entity, brief, skill, or catalog |
artifactName | Optional: one artifact |
days | Default 7, max 90 |
format | markdown (default) · json |
Answers are org-wide, like the Observe tab — managers read the same numbers admins do.
Get Change Log
The configuration ledger: who created, activated, rolled back, deactivated, or deleted what, when, with which comment. Managers see the domains they manage.
| Input | Notes |
|---|---|
library | Optional: entity, brief, skill, or domain |
artifactName | Optional: one artifact |
days | Default 30, max 365 |
maxRows | Default 50, max 200 |
format | markdown (default) · json |
Get Full Config
The configuration graph, scoped by domain, object, or entity list. Shapes: analysis (default — activation state, routing, effective writability) or export (the round-trip bundle). Unscoped reads require an explicit unscoped=true.
Save Draft
Compose or update a draft. A draft serves no one until activated.
library | Takes |
|---|---|
brief (default) | Type, label, description, content, refusal policy, customer-safe, synonyms, review-by, home domain |
skill | Label, description, procedure, output shape, surface, synonyms, home domain |
entity | Description, instructions, synonyms — text only, existing entities only |
Domain managers draft into domains they manage; a new artifact must name a managed home domain. Agent-composed brief drafts carry a “composed via” attribution.
Activate Draft
Publishes a draft as the next served version.
- The agent calls without
confirm. The preview shows the current version, the changed parts, the routing, the exact content that will serve, and a digest. - Approve the preview.
- The agent calls again with
confirm=true, the digest, and a comment — the comment lands in the Change Log.
A stale digest — the draft changed since the preview — is refused.
Update Domain Contents
Adds or removes an entity, brief, or skill from a domain, with the same preview-then-confirm flow. The preview shows routing before and after, and whether the change reaches users immediately (it does when the artifact is active). Requires roster rights on the domain. For briefs, delivery picks the tier: offered (body on request), catalog (body rides the catalog response, once per discovery call), or injected (body rides every payload the domain serves). → Delivery
Deactivate
Withdraws an artifact from service immediately. The preview names what stops serving and where; confirm=true pulls it. Versions are kept — re-activating restores service.
Get Skill
Fetches a packaged procedure by API name; the agent then follows it. See the skills.