scf_system_write
Create or update systems, declare or update evidence capabilities, and queue collection-recipe generation in the SCF inventory by selecting the appropriate method.
Instructions
Manage the systems inventory (editor+): create or update a system, declare or update an evidence capability, or generate collection recipes (async). Pick with method.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Human-readable system name (required) [create] | New system name [update] Used by: create, update. | |
| notes | No | Free-text notes about the capability Used by: create_capability, update_capability. | |
| method | Yes | create: Create a system in the organization's infrastructure inventory (write — editor+ role). Systems can be linked to capabilities and evidence. update: Update a system record (write — editor+ role), including its boundary and recovery record. All fields are optional; only provided fields are applied. create_capability: Declare that a system can provide one evidence type (write — editor role). One entry per evidence_id per system; status defaults to potential, confidence to medium. update_capability: Update a system's evidence capability (write — editor role). Only passed fields change; move status potential → configured → active as the collector is wired up. generate_recipes: Queue AI generation of evidence-collection recipes for a system (write — editor+ role, async, HTTP 202). Poll scf_get_recipe_generation_status for progress. | |
| org_id | Yes | Organization UUID — obtain from scf_list_organizations | |
| status | No | Lifecycle status (default: active) [create] | New lifecycle status [update] Used by: create, update. | |
| vendor | No | Legacy free-text vendor name (prefer vendor_id for a structural link) [create] | New legacy free-text vendor name (prefer vendor_id) [update] Used by: create, update. | |
| category | No | Free-text category (e.g., 'SIEM', 'Endpoint', 'Identity') [create] | New free-text category [update] Used by: create, update. | |
| in_scope | No | Inside the assessment boundary (true) or outside (false); omit when not decided [create] | Assessment boundary: true (inside), false (outside), or null to mark it undecided [update] Used by: create, update. | |
| rpo_hours | No | Recovery point objective, in hours (≥ 0) [create] | Recovery point objective in hours (≥ 0); null clears [update] Used by: create, update. | |
| rto_hours | No | Recovery time objective, in hours (≥ 0) [create] | Recovery time objective in hours (≥ 0); null clears [update] Used by: create, update. | |
| system_id | No | System UUID to update — obtain from scf_list_systems [update] | System UUID — obtain from scf_list_systems [create_capability, update_capability, generate_recipes] Used by: update, create_capability, update_capability, generate_recipes. | |
| vendor_id | No | Vendor UUID to structurally link this system to — obtain from scf_list_vendors (same org) [create] | New structural vendor link (UUID, same org) — obtain from scf_list_vendors [update] Used by: create, update. | |
| criticality | No | Business criticality — one of: low, medium, high, critical [create] | Business criticality — one of: low, medium, high, critical; null clears [update] Used by: create, update. | |
| data_format | No | Format of the collected data, e.g. 'csv', 'json', 'pdf' Used by: create_capability, update_capability. | |
| description | No | Free-text description of the system [create] | New system description [update] Used by: create, update. | |
| evidence_id | No | Catalog evidence ID, e.g. E-IAM-01 Used by: create_capability. | |
| system_type | No | System classification — one of: cloud_provider, identity_provider, ticketing, logging, security_tool, code_repository, document_management, endpoint_management, vulnerability_management, email_security, security_awareness, password_manager, communication, hr_system, custom [create] | New system classification — one of: cloud_provider, identity_provider, ticketing, logging, security_tool, code_repository, document_management, endpoint_management, vulnerability_management, email_security, security_awareness, password_manager, communication, hr_system, custom [update] Used by: create, update. | |
| capability_id | No | Capability UUID — obtain from scf_list_system_capabilities Used by: update_capability. | |
| confidence_level | No | Confidence in evidence quality (default medium) [create_capability] | Confidence in evidence quality [update_capability] Used by: create_capability, update_capability. | |
| hosting_location | No | Where the system runs, e.g. a cloud region or data centre [create] | Where the system runs; null clears [update] Used by: create, update. | |
| capability_status | No | Capability status (default potential) [create_capability] | Capability status [update_capability] Used by: create_capability, update_capability. | |
| collection_method | No | How the evidence is collected Used by: create_capability, update_capability. | |
| catalog_template_id | No | System-catalog template ID to link — obtain from scf_list_system_catalog [create] | New system-catalog template ID link — obtain from scf_list_system_catalog [update] Used by: create, update. | |
| data_classification | No | Highest classification of data held — one of: public, internal, confidential, restricted [create] | Highest classification of data held — one of: public, internal, confidential, restricted; null clears [update] Used by: create, update. |