Appearance
SOP: Knowledge Vault Setup
Goal
Connect organizational knowledge sources to the AgentBrain Knowledge Vault so agents can ground answers in your internal truth.
Prerequisites
- Business tier or above (Knowledge Vault is not included on Starter)
- Admin role on AgentBrain
- Read credentials for each source you plan to connect
- A decision on which collections (logical groupings) your knowledge will live in
Steps
1. Plan your collection structure
A collection is a permission-scoped bundle of knowledge. Plan around access boundaries, not just topics. Common patterns:
- One collection per department (Engineering Docs, HR Docs, Finance Reports)
- One collection per sensitivity class (Public, Internal, Confidential)
- One collection per project for cross-functional work
2. Configure a data connector
In Knowledge → Connectors → Add:
- Pick the source type: PostgreSQL, MySQL, MongoDB, BigQuery, SQLite, Notion, ClickUp, LarkSuite, Bitrix24, or REST
- Enter the credentials (use a read-only credential for safety)
- Test the connection
3. Choose what to ingest
- For databases: pick tables and the row-projection logic
- For wikis: pick spaces or page trees
- For project tools: pick projects or boards
4. Configure sync schedule
- Continuous (recommended for fast-moving sources)
- Hourly
- Daily
- On demand
5. Run the initial ingest
- Start the first sync
- Monitor progress in Knowledge → Sync Jobs
- Re-runs of unchanged content are no-ops
6. Grant collection access via RBAC
- Open Settings → RBAC
- For each role, grant
readon the collections it needs - Use
writeandmanagesparingly
7. Attach knowledge to agents
In each agent definition:
- Add the collections the agent is allowed to retrieve from
- Configure top-k retrieval (default 5 chunks is a reasonable start)
- Test by asking the agent a question whose answer lives in that collection
Verification
- A test query to the agent surfaces the expected source
- The audit log shows
knowledge.readevents tied to the agent run - Users without the role do not see results from restricted collections
Rollback
- Pause or delete a misconfigured connector
- Remove the collection from agents until sync re-runs cleanly