Skip to content

Entity Types

Sibyl supports roughly 29 entity types for different kinds of knowledge. Understanding when to use each type helps keep your knowledge graph organized and searchable.

The full set, as accepted by --type on sibyl add and --kind on sibyl remember:

pattern, rule, template, guide, tool, language, topic, episode, knowledge_source, config_file, slash_command, project, epic, task, team, error_pattern, milestone, source, document, procedure, community, note, domain, artifact, decision, plan, idea, claim, session.

You rarely touch most of them directly. The sections below cover the types you choose by hand; crawler, analysis, and reflection paths create the rest.

Core Knowledge Types

Episode

Temporal knowledge snapshots - insights, learnings, and discoveries.

bash
sibyl add "Redis timeout root cause" "Connection pool exhaustion happens when..."

When to use:

  • Debugging discoveries
  • One-time learnings
  • Context-specific insights
  • Time-bound observations

Properties:

FieldDescription
episode_typeType: "wisdom", "discovery", "debug"
source_urlOriginal source URL
valid_fromWhen knowledge became valid
valid_toWhen knowledge was superseded

Pattern

Reusable coding patterns and best practices.

bash
sibyl add "Retry with exponential backoff" "Implementation pattern for resilient..." \
  --type pattern \
  --language python --language typescript

When to use:

  • Reusable code patterns
  • Best practices
  • Standard solutions to common problems
  • Implementation templates

Properties:

FieldDescription
categoryPattern category (e.g., "error-handling")
languagesApplicable programming languages
confidenceConfidence score (0-1)

Rule

Sacred constraints and invariants that must be followed.

bash
sibyl entity create --type rule \
  --name "Never commit secrets" \
  --content "API keys and passwords must never be committed to git"

When to use:

  • Security requirements
  • Code review checklist items
  • Architectural constraints
  • Team agreements

Properties:

FieldDescription
severityViolation severity: error, warning, info
enforcementHow the rule is enforced
exceptionsKnown valid exceptions

Template

Code or configuration templates.

When to use:

  • Boilerplate code
  • Configuration examples
  • Project scaffolds
  • Standard file structures

Properties:

FieldDescription
template_typeType: code, config, project
file_extensionExpected file extension
variablesTemplate variables to replace

Tool

Development tools and utilities.

When to use:

  • CLI tool documentation
  • Library usage notes
  • Service configurations
  • Integration guides

Properties:

FieldDescription
tool_typeType: cli, library, service
installationInstallation instructions
versionRecommended version

Topic

High-level concepts and knowledge areas.

When to use:

  • Domain concepts
  • Technology areas
  • Organizational knowledge
  • Taxonomy building

Properties:

FieldDescription
parent_topicParent topic for hierarchy

Memory Loop Types

These types are the vocabulary of the memory loop. They are the natural --kind values for sibyl remember and capture the durable thinking behind your work.

Decision

A choice made and the reasoning behind it.

bash
sibyl remember "Chose SurrealDB for the runtime" \
  "One engine replaces three backends, cutting operational surface" \
  --kind decision

When to use:

  • Architectural choices
  • Tool and library selections
  • Tradeoffs you want to be able to defend later

Plan

An intended approach or sequence of work.

bash
sibyl remember "Reflection OS rollout" "Phased per-org enablement" --kind plan

When to use:

  • Multi-step approaches before execution
  • Rollout and migration sequencing

Idea

A possibility worth keeping but not yet acted on.

bash
sibyl remember "Memory diff view" "Show what changed between two recalls" --kind idea

When to use:

  • Parking-lot thoughts
  • Future directions surfaced mid-task

Claim

An assertion about how something behaves or should behave.

bash
sibyl remember "Embedded Surreal is single-writer" \
  "Multi-process local dev serializes through one writer" --kind claim

When to use:

  • Statements that synthesis should be able to cite and verify

Session

A summary of a working session.

bash
sibyl remember "Auth implementation session" "Completed OAuth callback..." --kind session

When to use:

  • End-of-session handoffs
  • Created automatically when sibyl reflect --persist --source stores raw notes

Artifact

A produced output, such as a synthesized document.

When to use:

  • Created by sibyl synthesis remember for verified synthesis output
  • Anything that is a deliverable rather than a raw learning

Note

A free-form note. Notes attach to tasks or stand alone as raw memory.

bash
# Task note
sibyl note task_xyz "Found the root cause of the bug"

# Standalone free note
sibyl note "Surreal RPC path is /rpc, easy to forget"

Properties (task notes):

FieldDescription
task_idParent task UUID
author_type"agent" or "user"
author_nameAuthor identifier

Task Management Types

Task

Work items with full lifecycle management.

bash
sibyl task create --title "Implement OAuth" --project proj_abc --priority high

When to use:

  • Trackable work items
  • Features to implement
  • Bugs to fix
  • Improvements to make

Properties:

FieldDescription
statusWorkflow state (see below)
prioritycritical, high, medium, low, someday
project_idParent project UUID
epic_idParent epic UUID (optional)
assigneesList of assignees
due_dateDue date
estimated_hoursEffort estimate
actual_hoursTime spent
learningsWhat was learned
branch_nameGit branch
pr_urlPull request URL

Task Status Flow:

backlog <-> todo <-> doing <-> blocked <-> review <-> done -> archived

Project

Container for tasks and epics.

bash
sibyl project create --name "Auth System" --description "Authentication and authorization"

When to use:

  • Major initiatives
  • Product features
  • Standalone systems
  • Team efforts

Properties:

FieldDescription
statusplanning, active, on_hold, completed, archived
repository_urlGitHub repo URL
featuresMajor feature areas
tech_stackTechnologies used
total_tasksTask count
completed_tasksCompleted count

Epic

Feature initiative grouping related tasks.

bash
sibyl epic create --title "OAuth Integration" --project proj_abc

When to use:

  • Multi-task features
  • Sprint themes
  • Major milestones
  • Grouped deliverables

Properties:

FieldDescription
statusplanning, in_progress, blocked, completed, archived
prioritycritical, high, medium, low, someday
project_idParent project UUID (required)
total_tasksTasks in epic
completed_tasksCompleted tasks

Documentation Types

Source

A documentation source to be crawled.

bash
sibyl crawl add https://react.dev --name "React Docs" --depth 3

When to use:

  • External documentation
  • API references
  • Library guides
  • Internal wikis

Properties:

FieldDescription
urlSource URL
source_typewebsite, github, local, api_docs
crawl_statuspending, in_progress, completed, failed, partial
document_countCrawled document count

Document

A crawled document/page from a source.

When to use:

  • Created automatically by crawler
  • Represents individual pages
  • Contains chunked content

Properties:

FieldDescription
urlDocument URL
titlePage title
headingsExtracted headings
has_codeContains code blocks
languagePrimary language detected

Specialized Types

Error Pattern

Recurring errors and their solutions.

When to use:

  • Common error messages
  • Debugging solutions
  • Root cause analysis
  • Prevention strategies

Properties:

FieldDescription
error_messageError message pattern
root_causeWhy it happens
solutionHow to fix it
preventionHow to prevent it
occurrence_countTimes encountered

Team

Team information and membership.

When to use:

  • Team composition
  • Responsibility areas
  • Contact information

Properties:

FieldDescription
membersTeam member IDs
focus_areasAreas of responsibility

Milestone

Project timeline markers.

When to use:

  • Release targets
  • Sprint boundaries
  • Deadline tracking

Properties:

FieldDescription
project_idParent project
start_dateMilestone start
end_dateMilestone end
target_dateTarget completion

Guide

Team guidance and reference material.

When to use:

Procedure

A repeatable sequence of steps.

When to use:

  • Runbooks and checklists
  • Operational processes
  • Anything you would otherwise rewrite from memory each time

Domain

A bounded area of knowledge or responsibility.

When to use:

  • Grouping knowledge by problem space
  • Lightweight taxonomy above categories

Community

Entity clusters from graph analysis.

When to use:

  • Auto-generated by community detection
  • Represents related entity groups
  • Used for knowledge organization

Properties:

FieldDescription
key_conceptsMain concepts in community
member_countEntities in community
levelHierarchy level

Infrastructure Types

A handful of types exist for completeness and are created by specific paths rather than chosen by hand:

TypeCreated by
knowledge_sourceKnowledge ingestion paths that register an origin for memory
config_fileCapturing a configuration file as referenceable knowledge
slash_commandCapturing a slash command definition
languageProgramming-language nodes used for tagging and traversal

They accept the same --type flag if you ever need them, but most workflows never do.

Type Selection Guide

ScenarioRecommended Type
"I just figured something out"episode
"This is how we always do X"pattern
"This must never happen"rule
"We chose A over B, here's why"decision
"Here's the approach I'll take"plan
"Worth trying later"idea
"X behaves like this"claim
"I need to implement X"task
"X is a major feature area"epic
"X is a big initiative"project
"Here's useful external docs"source
"This error keeps happening"error_pattern
"A repeatable runbook"procedure
"Template for new services"template

Creating Entities

Via CLI

bash
# Episodes (default type)
sibyl add "Title" "Content"

# Specific types
sibyl add "Title" "Content" --type pattern
sibyl entity create --type rule --name "..." --content "..."

Via MCP Tools

python
# Using the add tool
add(
    title="Pattern name",
    content="Pattern description",
    entity_type="pattern",
    languages=["python"],
    category="error-handling"
)

Via REST API

bash
curl -X POST http://localhost:3334/api/entities \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Entity name",
    "content": "Entity content",
    "entity_type": "pattern"
  }'

Next Steps

Released under the Apache-2.0 License.