Skip to main content

API Reference

Every parameter, every default, every return value for OMEGA's 12 MCP tools.

Called at session boundaries to orient the agent.

omega_welcome

Get a session welcome briefing with recent relevant memories and user profile. Call this first at the start of every session.

Parameters

ParameterTypeDefaultDescription
projectstringProject path for scoping the briefing.
session_idstringSession identifier for continuity tracking.

Example

omega_welcome
# Start of session
$omega_welcome(project="/Users/me/myapp")
[WELCOME]Session briefing ready
Profile: 12 encrypted fields
Recent: 3 decisions, 2 lessons
Tasks: 2 pending checkpoints

omega_protocol

Get your coordination playbook: dynamically assembled operating instructions. Call at session start (step 2 after omega_welcome) or when you need protocol guidance.

Parameters

ParameterTypeDefaultDescription
sectionstringSection to retrieve: 'memory', 'coordination', 'coordination_gate', 'teamwork', 'context', 'reminders', 'diagnostics', 'entity', 'heuristics', 'git', 'what_next'. Groups: 'solo', 'multi_agent', 'full', 'minimal'.
projectstringProject path for context-sensitive rules.

Example

omega_protocol
$omega_protocol(section="memory")
[PROTOCOL]Memory section loaded
Store decisions after completing tasks
Query before non-trivial work
Checkpoint when context is filling up

Core read/write operations for persistent memory.

omega_store

Store a memory with optional type and metadata. Use when the user says 'remember this' or for programmatic capture of decisions, lessons, errors, and preferences.

Parameters

ParameterTypeDefaultDescription
contentreqstringMemory content to store (also accepts 'text' as alias).
event_typestring"memory"Type: memory, session_summary, task_completion, error_pattern, lesson_learned, decision, user_preference, constraint.
priorityintegerautoPriority 1-5 (5 = highest). Auto-set from event type if omitted.
entity_idstringScope this memory to an entity (e.g., 'acme'). Omit for unscoped.
projectstringProject path for scoping.
session_idstringSession identifier.
metadataobjectAdditional metadata to attach.
agent_typestringAgent type for sub-agent memory scoping (e.g., 'code-reviewer').

Example

omega_store
$omega_store(
content="Always use bun instead of npm",
event_type="user_preference"
)
Stored as user_preference (priority 4)

omega_query

Search memories. Three modes: 'semantic' (default) for meaning-based search, 'phrase' for exact substring match, 'timeline' for recent memories grouped by day.

Parameters

ParameterTypeDefaultDescription
querystringSearch query (or exact phrase when mode='phrase'). Not required for timeline mode.
modestring"semantic"Search mode: 'semantic', 'phrase', or 'timeline'.
limitinteger10Maximum number of results to return.
event_typestringFilter by event type.
entity_idstringFilter to a specific entity.
filter_tagsstring[]Hard filter: ALL tags must match (AND logic).
context_tagsstring[]Context tags for relevance boosting.
context_filestringCurrent file being edited (boosts related results).
daysinteger7Days to look back (only for timeline mode).
temporal_rangestring[][start_iso, end_iso] date range filter.
projectstringProject path for scoping.
session_idstringSession identifier.
agent_typestringFilter to a specific agent type.
case_sensitivebooleanfalseCase-sensitive search (only for phrase mode).
limit_per_dayinteger10Max results per day (only for timeline mode).

Example

omega_query
$omega_query(query="authentication setup")
[RESULTS]3 memories found (semantic)
0.92 "JWT auth configured with RS256..."
0.87 "Auth middleware added to /api/..."
0.81 "User table schema includes..."

omega_memory

Manage individual memories: edit content, delete, give feedback (helpful/unhelpful/outdated), find similar memories, or traverse the relationship graph.

Parameters

ParameterTypeDefaultDescription
actionreqstringOperation: 'edit', 'delete', 'feedback', 'similar', or 'traverse'.
memory_idreqstringMemory node ID to operate on.
new_contentstringNew content (only for action='edit').
ratingstringFeedback rating: 'helpful', 'unhelpful', or 'outdated' (only for action='feedback').
reasonstringOptional explanation for feedback.
limitinteger5Max results for similar search.
max_hopsinteger2Traversal depth 1-5 (only for action='traverse').
min_weightnumber0.0Min edge weight 0.0-1.0 (only for action='traverse').

Example

omega_memory
$omega_memory(
action="feedback",
memory_id="abc123",
rating="outdated",
reason="API endpoint changed in v2"
)
Marked as outdated

Task continuity, lessons, and reminders across sessions.

omega_checkpoint

Save a task checkpoint: captures current plan, progress, files touched, decisions, and key context. Enables seamless session continuity.

Parameters

ParameterTypeDefaultDescription
task_titlereqstringBrief title of the current task.
progressreqstringWhat's been completed, in progress, and remaining.
planstringCurrent plan or goals.
decisionsstring[]Key technical decisions made.
files_touchedobjectMap of file paths to change summaries.
key_contextstringCritical context for continuation.
next_stepsstringWhat to do next.
projectstringProject path.
session_idstringSession identifier.

Example

omega_checkpoint
$omega_checkpoint(
task_title="Auth system migration",
progress="JWT middleware done, user model updated",
next_steps="Wire up refresh token rotation",
decisions=["RS256 over HS256", "15min access tokens"]
)
Checkpoint saved

omega_resume_task

Resume a previously checkpointed task. Retrieves the latest checkpoint with full plan, progress, files, decisions, and next steps.

Parameters

ParameterTypeDefaultDescription
task_titlestringTitle of the task to resume (semantic search).
projectstringProject path to filter checkpoints.
limitinteger1Number of checkpoints to retrieve.
verbositystring"full"'full' = everything, 'summary' = plan + progress + next, 'minimal' = next steps only.

Example

omega_resume_task
$omega_resume_task(task_title="Auth migration")
[CHECKPOINT]Auth system migration
Progress: JWT middleware done, user model updated
Next: Wire up refresh token rotation
Decisions: RS256 over HS256, 15min tokens

omega_lessons

Retrieve cross-session or cross-project lessons learned, ranked by verification count and access frequency.

Parameters

ParameterTypeDefaultDescription
taskstringTask description for relevance filtering.
project_pathstringProject scope.
limitinteger5Max lessons to return.
cross_projectbooleanfalseSearch across all projects.
agent_typestringFilter to a specific agent type.
exclude_projectstringProject to exclude (with cross_project=true).
exclude_sessionstringSession ID to exclude.

Example

omega_lessons
$omega_lessons(task="database migration")
[LESSONS]3 lessons found
(5x verified) Always run migrations in a transaction
(3x verified) Test rollback before deploying
(2x verified) Back up production data first

omega_remind

Manage time-based reminders: set new reminders, list active ones, or dismiss by ID.

Parameters

ParameterTypeDefaultDescription
actionstring"set"Action: 'set', 'list', or 'dismiss'.
textstringWhat to be reminded about (for action='set').
durationstringWhen to remind, e.g. '1h', '30m', '2d' (for action='set').
contextstringOptional context for the reminder.
reminder_idstringReminder ID (for action='dismiss').
statusstringFilter for list: 'pending', 'fired', 'dismissed', or 'all'.
projectstringProject path.
session_idstringSession identifier.

Example

omega_remind
$omega_remind(
text="Check CI pipeline results",
duration="30m"
)
Reminder set for 30 minutes

Maintenance, analytics, and user profile management.

omega_profile

Read or update user profile, or list stored preferences. Profile data is encrypted at rest.

Parameters

ParameterTypeDefaultDescription
actionstring"read"Action: 'read', 'update', or 'list_preferences'.
updateobjectProfile fields to merge (only for action='update').

Example

omega_profile
$omega_profile(action="read")
[PROFILE]User profile
Name: Jason
Preferences: 8 stored
Encrypted fields: 12

omega_maintain

System maintenance: health checks, memory consolidation, compaction, backup/restore, and session cleanup.

Parameters

ParameterTypeDefaultDescription
actionreqstringOperation: 'health', 'consolidate', 'compact', 'backup', 'restore', or 'clear_session'.
dry_runbooleanfalsePreview only (for compact).
event_typestring"lesson_learned"Type to compact.
similarity_thresholdnumber0.6Jaccard similarity 0.0-1.0 (for compact).
min_cluster_sizeinteger3Min cluster size (for compact).
prune_daysinteger30Prune zero-access memories older than N days (for consolidate).
max_summariesinteger50Max session summaries (for consolidate).
filepathstringFile path for backup/restore.
session_idstringSession to purge (for clear_session).
warn_mbnumber350Warning threshold in MB (for health).
critical_mbnumber800Critical threshold in MB (for health).
max_nodesinteger10000Max expected nodes (for health).
clear_existingbooleantrueClear before restore.

Example

omega_maintain
$omega_maintain(action="health")
[HEALTH]System status
Memories: 663 nodes, 4.2 MB
Status: healthy
Last backup: 2h ago

omega_stats

Memory analytics: type breakdown, session stats, weekly digest, or forgetting audit log.

Parameters

ParameterTypeDefaultDescription
actionreqstringWhich stats to retrieve: 'types', 'sessions', 'digest', or 'forgetting_log'.
daysinteger7Days for digest.
limitinteger50Max entries for forgetting_log.
reasonstringFilter forgetting_log by reason.

Example

omega_stats
$omega_stats(action="types")
[STATS]Memory type breakdown
decision: 142
lesson_learned: 89
user_preference: 34
error_pattern: 28
memory: 370

omega_reflect

Pro

Analyze memory health: find contradictions between memories, track how decisions evolved over time, or identify stale memories that may need review.

Parameters

ParameterTypeDefaultDescription
actionreqstringAnalysis type: 'contradictions', 'evolution', or 'stale'.
topicstringTopic to analyze (for contradictions/evolution).
daysinteger30Lookback window in days (for stale).
limitinteger10Max results to return.

Example

omega_reflect
$omega_reflect(action="contradictions", topic="auth")
[REFLECT]1 contradiction found
Memory #42: "Use JWT with RS256"
Memory #87: "Switch to session tokens"
Suggestion: Resolve or mark one as outdated