Перейти до вмісту
← На сайт
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>_vault26
Admin<id>_admin56
Chat<id>_chat41
Plan<id>_plan32
Brain<id>_brain30
Orchestrate<id>_orchestrate26
Memory<id>_memory15
Agency<id>_agency15
Curator<id>_curator13
Control<id>_control13
Archive<id>_archive12
Operator<id>_operator10
Loop<id>_loop9
Links<id>_links9
Sync<id>_sync8
Intake<id>_intake7
Tier<id>_tier7
Branching<id>_branching5
Review<id>_review5
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 a session using 6 heuristic rules.

ParamTypeRequiredDescription
sessionIdstringyesSession ID to extract from

Analyze a learning signal — auto-captures, queues, or logs based on confidence.

ParamTypeRequiredDescription
typeenumyescorrection, search_miss, explicit_capture, pattern_success, workaround, repeated_question
titlestringyesShort title for the detected pattern
descriptionstringyesWhat was learned and why
suggestedTypeenumnopattern or anti-pattern
confidencenumbernoOverride confidence (0-1)
sourceQuerystringnoOriginal query that triggered the signal
contextstringnoAdditional context

Synthesize vault knowledge into structured content.

ParamTypeRequiredDescription
querystringyesTopic to synthesize about
formatenumyesbrief, outline, talking-points, post-draft
maxEntriesnumbernoMax vault entries to consult (default: 10)
audienceenumnotechnical, executive, general (default)

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)

Evaluate suggestion rules and return triggered proactive suggestions.

No parameters required.

Suppress a warning by ID.

ParamTypeRequiredDescription
warningIdstringyesWarning ID to suppress

Archive entries older than N days.

ParamTypeRequiredDescription
olderThanDaysnumberyesArchive entries older than N days
reasonstringnoReason for archiving

Restore an archived entry back to the active table.

ParamTypeRequiredDescription
idstringyesID of the archived entry

Merge two similar entries — keeps best metadata from both.

ParamTypeRequiredDescription
keepIdstringyesEntry to keep
removeIdstringyesDuplicate entry to remove

Re-categorize entries — rename domains/tags. Dry-run by default.

ParamTypeRequiredDescription
dryRunbooleannoPreview without changes (default: true)
retagRulesarrayno[{ from: string, to?: string }] tag rules
domainRulesarrayno[{ from: string, to: string }] domain rules

Get the full operator profile or a specific section.

ParamTypeRequiredDescription
sectionenumnoidentity, cognition, communication, workingRules, trustModel, tasteProfile, growthEdges, technicalContext

Accumulate operator signals for later synthesis.

ParamTypeRequiredDescription
signalsarrayyes[{ id, signalType, data, timestamp, sessionId, confidence }]

Check if a synthesis pass is due based on signal/session thresholds. No parameters required.

Export the operator profile as markdown or JSON.

ParamTypeRequiredDescription
formatenumnomarkdown or json (default)

Push vault entries to a git-tracked directory.

ParamTypeRequiredDescription
repoDirstringyesPath to git-tracked directory
authorNamestringnoGit author name
authorEmailstringnoGit author email

Pull entries from a git directory into the vault.

ParamTypeRequiredDescription
repoDirstringyesPath to git-tracked directory
onConflictenumnogit (default) or vault conflict resolution

Export vault entries as a shareable intelligence pack.

ParamTypeRequiredDescription
namestringnoPack name (default: agent ID)
versionstringnoPack version (default: 1.0.0)
tierenumnoagent, project, or team
domainstringnoFilter by domain
tagsstring[]noFilter by tags
excludeIdsstring[]noEntry IDs to exclude

Import an intelligence pack with dedup.

ParamTypeRequiredDescription
bundlesarrayyesArray of IntelligenceBundle objects
tierenumnoForce all imports to this tier

Submit a vault entry for team review.

ParamTypeRequiredDescription
entryIdstringyesEntry ID to submit
submittedBystringnoName/ID of submitter

Approve a pending vault entry.

ParamTypeRequiredDescription
entryIdstringyesEntry ID
reviewedBystringnoName/ID of reviewer
commentstringnoReview comment

Reject a pending vault entry.

ParamTypeRequiredDescription
entryIdstringyesEntry ID
reviewedBystringnoName/ID of reviewer
commentstringnoReason for rejection

Fetch a URL, extract text, classify via LLM, and store.

ParamTypeRequiredDescription
urlstringyesURL to fetch and ingest
domainstringnoKnowledge domain
tagsstring[]noAdditional tags

Ingest raw text — classify via LLM and store.

ParamTypeRequiredDescription
textstringyesText content to ingest
titlestringyesTitle for the source material
sourceTypeenumnoarticle, transcript, notes, documentation
urlstringnoSource URL if available
authorstringnoAuthor of the source material
domainstringnoKnowledge domain
tagsstring[]noAdditional tags

Ingest multiple text items in one call.

ParamTypeRequiredDescription
itemsarrayyes[{ text, title, sourceType?, url?, author?, domain?, tags? }]

Create a typed link between two vault entries.

ParamTypeRequiredDescription
sourceIdstringyesSource entry ID
targetIdstringyesTarget entry ID
linkTypeenumyessupports, contradicts, extends, sequences
notestringnoContext for the link

Walk the link graph from an entry up to N hops deep.

ParamTypeRequiredDescription
entryIdstringyesStarting entry ID
depthnumbernoMax hops, 1-5 (default: 2)

Find semantically similar entries as link candidates.

ParamTypeRequiredDescription
entryIdstringyesEntry to find candidates for
limitnumbernoMax suggestions (default: 5)

Find entries with zero links.

ParamTypeRequiredDescription
limitnumbernoMax orphans (default: 20)

Smart re-linking using LLM evaluation.

ParamTypeRequiredDescription
batchSizenumbernoPairs per LLM call (default: 10)
limitnumbernoMax entries to process (0 = all)
dryRunbooleannoPreview without changes (default: false)

Create a named vault branch.

ParamTypeRequiredDescription
namestringyesUnique branch name

Add an operation to a branch.

ParamTypeRequiredDescription
branchNamestringyesBranch name
entryIdstringyesEntry ID
actionenumyesadd, modify, or remove
entryDataobjectnoFull entry data (for add/modify)

Merge a branch into the main vault.

ParamTypeRequiredDescription
branchNamestringyesBranch to merge

Auth: admin


Connect an additional vault tier.

ParamTypeRequiredDescription
tierenumyesproject or team
pathstringyesPath to SQLite database

Auth: admin

Search across all connected vault tiers.

ParamTypeRequiredDescription
querystringyesSearch query
limitnumbernoMax results (default: 20)

Connect a named vault source with priority.

ParamTypeRequiredDescription
namestringyesUnique name for the connection
pathstringyesPath to SQLite database
prioritynumbernoSearch priority 0-2 (default: 0.5)

Auth: admin


Extract named entities from a prompt.

ParamTypeRequiredDescription
promptstringyesPrompt to analyze

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

Retrieve relevant knowledge from vault 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 350+ operations across 20 facades, see Capabilities. For CLI commands, see CLI Reference. For term definitions, see Glossary.