Skip to content
← Back to site
Soleri | Docs

API Reference

Every Soleri agent exposes operations through facades — single MCP tool entry points that dispatch to operations via the op parameter.

{
"tool": "my_agent_vault",
"input": {
"op": "search",
"params": {
"query": "authentication patterns",
"domain": "security",
"limit": 5
}
}
}

Every response follows the same envelope:

{
"success": true,
"data": { ... },
"op": "search",
"facade": "my_agent_vault"
}

Each agent gets facades named <agent_id>_<facade>:

FacadeTool nameOps
Vault<id>_vault66
Admin<id>_admin56
Chat<id>_chat41
Plan<id>_plan32
Orchestrate<id>_orchestrate26
Brain<id>_brain23
Memory<id>_memory15
Curator<id>_curator13
Control<id>_control13
Cognee<id>_cognee11
Loop<id>_loop9
Agency<id>_agency8
Context<id>_context3
Domain<id>_<domain>5 each

Search across all knowledge domains.

ParamTypeRequiredDescription
querystringyesSearch query text
domainstringnoRestrict to a specific domain
typeenumnopattern, anti-pattern, rule, playbook
severityenumnocritical, warning, suggestion
tagsstring[]noFilter by tags
limitnumbernoMax results (default: 10)

Quick-capture a knowledge entry with minimal input.

ParamTypeRequiredDescription
titlestringyesEntry title
descriptionstringyesWhat this pattern/anti-pattern is about
typeenumnoDefault: pattern
domainstringnoKnowledge domain
severityenumnoDefault: suggestion
tagsstring[]noFree-form tags

Full knowledge capture with all metadata.

ParamTypeRequiredDescription
titlestringyesEntry title
descriptionstringyesFull description
typeenumyesEntry type
domainstringnoKnowledge domain
severityenumnoSeverity level
tagsstring[]noTags
categorystringnoCategory grouping
examplestringnoCode example
whystringnoRationale
contextstringnoWhen this applies

Semantic search with 6-dimension scoring.

ParamTypeRequiredDescription
querystringyesSearch query
optionsobjectnoFilter options (domain, type, severity, limit)

Create a named vault branch for experimentation.

ParamTypeRequiredDescription
branchNamestringyesBranch name
createdBystringnoWho created it

Ingest a PDF book into vault knowledge.

ParamTypeRequiredDescription
pdfPathstringyesPath to PDF file
titlestringyesBook title
authorstringyesBook author
targetScopeenumnoglobal or project
focusCategoriesstring[]noCategories to focus extraction on
chunkPageSizenumbernoPages per chunk
dryRunbooleannoPreview without importing

Bidirectional sync with Obsidian.

ParamTypeRequiredDescription
projectPathstringyesProject directory
obsidianVaultPathstringyesPath to Obsidian vault
directionenumnopush, pull, or bidirectional
dryRunbooleannoPreview without changes

Create a multi-step execution plan.

ParamTypeRequiredDescription
titlestringyesPlan title
objectivestringyesWhat this plan achieves
tasksarrayyes[{ title: string, description: string }]

Design-before-code brainstorming with domain awareness.

ParamTypeRequiredDescription
objectivestringyesWhat you’re brainstorming
scopestringnoScope description
intentenumnoBUILD, FIX, REVIEW, PLAN, IMPROVE, DELIVER

Grade a plan against quality criteria.

ParamTypeRequiredDescription
planCheckIdstringyesPlan check ID to grade

Submit evidence for task acceptance criteria.

ParamTypeRequiredDescription
taskCheckIdstringyesTask check ID
evidencearrayyes[{ criterion, evidence, command?, satisfied }]

Get context-aware recommendations.

ParamTypeRequiredDescription
contextstringnoCurrent task context
limitnumbernoMax recommendations (default: 5)

Record feedback to the learning system.

ParamTypeRequiredDescription
typestringyesFeedback type
sourcestringnoFeedback source
acceptedbooleannoWhether the recommendation was used
confidencenumbernoConfidence level (0-1)

Extract patterns from session history.

ParamTypeRequiredDescription
limitnumbernoMax sessions to analyze
sincestringnoISO date — only analyze after this
persistbooleannoWhether to persist extracted patterns

Create an orchestrated plan with vault + brain context.

ParamTypeRequiredDescription
promptstringyesWhat needs to be done
projectPathstringyesProject directory path

Start executing a playbook.

ParamTypeRequiredDescription
playbookIdstringyesPlaybook ID to start

Find playbooks that match a context.

ParamTypeRequiredDescription
contextstringyesContext to match against

Initialize chat session management.

ParamTypeRequiredDescription
storageDirstringyesDirectory for session persistence
ttlMsnumbernoSession TTL in ms (default: 2 hours)
compactionThresholdnumbernoMessages before auto-compaction
compactionKeepnumbernoMessages to keep after compaction

Append a message to a session.

ParamTypeRequiredDescription
sessionIdstringyesSession ID
storageDirstringyesStorage directory
roleenumyesuser, assistant, system, or tool
contentstringyesMessage content

Initialize chat authentication.

ParamTypeRequiredDescription
storagePathstringyesPath for auth storage
passphrasestringnoAuth passphrase
allowedUsers(string|number)[]noAllowed user IDs

Transcribe audio using OpenAI Whisper.

ParamTypeRequiredDescription
audioBase64stringyesBase64-encoded audio
openaiApiKeystringyesOpenAI API key
filenamestringnoOriginal filename

Enable proactive file watching.

ParamTypeRequiredDescription
projectPathstringnoProject root to watch (default: .)

Update agency configuration.

ParamTypeRequiredDescription
watchPathsstring[]noDirectories to watch
ignorePatternsstring[]noGlob patterns to ignore
extensionsstring[]noFile extensions to watch
debounceMsnumbernoDebounce interval
minPatternConfidencenumbernoMin confidence to surface a pattern
cooldownMsnumbernoCooldown between alerts

Manually scan a file for warnings.

ParamTypeRequiredDescription
filePathstringyesPath to file to scan

Generate clarification for ambiguous intent.

ParamTypeRequiredDescription
promptstringyesThe user prompt to analyze
confidencenumberyesCurrent intent confidence (0-1)

Extract named entities from a prompt.

ParamTypeRequiredDescription
promptstringyesPrompt to analyze

Returns: files, functions, domains, actions, technologies, patterns.

Retrieve relevant knowledge from vault, Cognee, and brain.

ParamTypeRequiredDescription
promptstringyesQuery to search
domainstringnoFilter by domain

Full context analysis — combines entity extraction and knowledge retrieval.

ParamTypeRequiredDescription
promptstringyesPrompt to analyze
domainstringnoOptional domain hint

Each domain gets its own facade: <agent_id>_<domain>.

ParamTypeRequiredDescription
tagsstring[]noFilter by tags
severityenumnoFilter by severity
limitnumbernoMax results
ParamTypeRequiredDescription
querystringyesSearch query
limitnumbernoMax results
ParamTypeRequiredDescription
idstringyesEntry ID
ParamTypeRequiredDescription
titlestringyesEntry title
descriptionstringyesEntry description
typeenumnoEntry type (default: pattern)
severityenumnoSeverity level
tagsstring[]noTags
ParamTypeRequiredDescription
idstringyesEntry ID to remove

Auth: admin


For the complete list of all 200+ operations, see Capabilities. For CLI commands, see CLI Reference. For term definitions, see Glossary.