79 lines
6.9 KiB
Markdown
79 lines
6.9 KiB
Markdown
# Plan Detail
|
||
|
||
## Step 0: Define the normalized ingestion contract and pluggable source-connector interface for SCM, CMS, and other content sources.
|
||
|
||
- **Capability:** Specify KAB-compatible connector inputs and outputs, normalized document structure, provenance, access controls, synchronization cursors, and trigger/configuration semantics.
|
||
- **Plan label:** gap
|
||
- **Reusable capability:** False
|
||
- **Rationale:** This is the contract and interface for this deliverable; it is necessary to implement the requested agent but is not a separately discoverable capability beyond the agent repository.
|
||
- **Input schema:** `{'goal': 'string', 'constraints': 'string[]'}`
|
||
- **Output schema:** `{'ingestion_contract': 'object', 'connector_interface': 'object', 'normalized_document_schema': 'object', 'provenance_schema': 'object', 'access_control_schema': 'object', 'sync_cursor_schema': 'object', 'trigger_configuration_schema': 'object'}`
|
||
- **Acceptance criteria:** (none)
|
||
- **Success conditions:** (none)
|
||
|
||
## Step 1: Implement a GitHub SCM connector that conforms to the normalized ingestion contract and supports scoped full and incremental ingestion of Markdown, plain-text, and source files with webhook and revision metadata.
|
||
|
||
- **Capability:** Build a contract-compliant GitHub connector with repository and path scoping, authenticated retrieval, change-based synchronization, webhook-triggered updates, normalized documents, provenance, access controls, and synchronization cursors.
|
||
- **Plan label:** gap
|
||
- **Reusable capability:** False
|
||
- **Rationale:** This is a source-specific implementation included in the requested agent’s first-version deliverable, not an independently reusable registry agent.
|
||
- **Input schema:** `{'ingestion_contract': 'object', 'connector_interface': 'object', 'normalized_document_schema': 'object', 'provenance_schema': 'object', 'access_control_schema': 'object', 'sync_cursor_schema': 'object', 'trigger_configuration_schema': 'object'}`
|
||
- **Output schema:** `{'github_connector': 'object', 'ingestion_contract': 'object', 'connector_interface': 'object'}`
|
||
- **Acceptance criteria:** (none)
|
||
- **Success conditions:** (none)
|
||
|
||
## Step 2: Implement a SharePoint CMS connector that conforms to the normalized ingestion contract and supports scoped full and incremental ingestion of PDF, DOCX, and HTML files with webhook and revision metadata.
|
||
|
||
- **Capability:** Build a contract-compliant SharePoint connector with site, library, folder, and file scoping; authenticated retrieval; change-based synchronization; webhook-triggered updates; normalized documents; provenance; access controls; and synchronization cursors.
|
||
- **Plan label:** gap
|
||
- **Reusable capability:** False
|
||
- **Rationale:** This is a source-specific implementation included in the requested agent’s first-version deliverable, not an independently reusable registry agent.
|
||
- **Input schema:** `{'ingestion_contract': 'object', 'connector_interface': 'object', 'normalized_document_schema': 'object', 'provenance_schema': 'object', 'access_control_schema': 'object', 'sync_cursor_schema': 'object', 'trigger_configuration_schema': 'object'}`
|
||
- **Output schema:** `{'sharepoint_connector': 'object', 'ingestion_contract': 'object', 'connector_interface': 'object'}`
|
||
- **Acceptance criteria:** (none)
|
||
- **Success conditions:** (none)
|
||
|
||
## Step 3: Implement ingestion orchestration and triggers
|
||
|
||
- **Capability:** Coordinate KAB ingestion connectors for on-demand, scheduled, and webhook-triggered full or incremental synchronization, including retries, idempotency, run tracking, and dead-letter handling.
|
||
- **Plan label:** gap
|
||
- **Reusable capability:** False
|
||
- **Rationale:** Orchestration is part of this standalone ingestion agent and coordinates its connectors; it is not being requested as a separately reusable platform capability.
|
||
- **Input schema:** `{'ingestion_contract': 'object', 'connector_interface': 'object', 'github_connector': 'object', 'sharepoint_connector': 'object'}`
|
||
- **Output schema:** `{'ingestion_orchestrator': 'object', 'ingestion_batch': 'object', 'sync_run_results': 'object', 'dead_letter_items': 'object'}`
|
||
- **Acceptance criteria:** (none)
|
||
- **Success conditions:** (none)
|
||
|
||
## Step 4: Normalize, govern, and publish ingested content to the shared knowledge store.
|
||
|
||
- **Capability:** Extract and normalize connector outputs, propagate ACLs and tenant isolation, use managed secrets, record audit events, apply retention and deletion rules, and publish governed documents for downstream platform agents.
|
||
- **Plan label:** gap
|
||
- **Reusable capability:** False
|
||
- **Rationale:** These behaviors implement the requested agent’s downstream contract and governance requirements, so they remain deliverable content in the agent repository.
|
||
- **Input schema:** `{'ingestion_batch': 'object', 'sync_run_results': 'object', 'dead_letter_items': 'object'}`
|
||
- **Output schema:** `{'published_documents': 'object', 'knowledge_store_publication': 'object', 'audit_events': 'object', 'deletion_results': 'object', 'retention_results': 'object', 'publication_summary': 'object'}`
|
||
- **Acceptance criteria:** (none)
|
||
- **Success conditions:** (none)
|
||
|
||
## Step 5: Add deployment/configuration, tests, and documentation for the ingestion agent.
|
||
|
||
- **Capability:** Package the ingestion agent with CI/CD-aligned deployment configuration, connector and synchronization examples, automated contract and integration tests, and operational documentation covering setup, monitoring, recovery, security, and lifecycle management.
|
||
- **Plan label:** gap
|
||
- **Reusable capability:** False
|
||
- **Rationale:** These are acceptance and operational artifacts for this specific agent deliverable, not standalone reusable registry capabilities.
|
||
- **Input schema:** `{'published_documents': 'object', 'knowledge_store_publication': 'object', 'audit_events': 'object', 'deletion_results': 'object', 'retention_results': 'object', 'publication_summary': 'object'}`
|
||
- **Output schema:** `{'deployment_configuration': 'object', 'ci_cd_workflow': 'object', 'configuration_examples': 'object', 'automated_test_results': 'object', 'operational_documentation': 'object', 'packaging_summary': 'object'}`
|
||
- **Acceptance criteria:** (none)
|
||
- **Success conditions:** (none)
|
||
|
||
## Step 6: Validate end-to-end ingestion and downstream content availability.
|
||
|
||
- **Capability:** Execute representative full, incremental, scheduled, and webhook-triggered flows across configured connectors, verify governed publication and downstream agent retrieval with tenant and ACL isolation, and report operational readiness.
|
||
- **Plan label:** gap
|
||
- **Reusable capability:** False
|
||
- **Rationale:** (none recorded)
|
||
- **Input schema:** `{'deployment_configuration': 'object', 'automated_test_results': 'object', 'operational_documentation': 'object', 'packaging_summary': 'object'}`
|
||
- **Output schema:** `{'end_to_end_validation': 'object', 'downstream_access_validation': 'object', 'security_isolation_validation': 'object', 'operational_readiness': 'object', 'release_summary': 'object'}`
|
||
- **Acceptance criteria:** (none)
|
||
- **Success conditions:** (none)
|