Skip to main content

API Reference

Benchmarked against: Anthropic — API Reference Protocol: MCP (Model Context Protocol) Scope: Complete reference for SuperPortia's tool-based API surface

SuperPortia's API is exposed through MCP servers. Unlike traditional REST APIs, these tools are designed to be discovered and invoked by AI agents through natural language reasoning.


API surface overview​

DomainServerTool countDescription
KnowledgeCloud UB12Search, ingest, CRUD, stats
Work OrdersCloud UB10Create, status, review, dispatch
CommunicationCloud UB5Messaging, mailbox, heartbeat
OperationsCloud UB3Factory floor, captain location, SRE
IntelligenceLocal UBI4Intel search, patrol, web search, call_model
File OperationsLocal UBI5Read, write, edit, list, search
InfrastructureCloudflare2Execute, search OpenAPI spec
DatabaseSupabase15+SQL, migrations, edge functions
BrowserChrome12+Navigation, screenshots, interaction

Knowledge API​

search_brain​

Search the Universal Brain using hybrid search (FTS5 keyword + semantic vector).

ParameterTypeRequiredDefaultDescription
querystringYes—Search query (English recommended)
limitnumberNo10Maximum results

ingest_fragment​

Ingest content into UB through the MTAAA 5-node pipeline.

ParameterTypeRequiredDefaultDescription
pathstringYes—File path, text content, or URL
input_typestringNofilefile, text, url, screenshot
sourcestringNomanualmanual, nq_alpha, ss_vault, downloads, api

get_entry​

Retrieve a single UB entry by ID.

ParameterTypeRequiredDescription
entry_idstringYesEntry ID (e.g., ub-a1b2c3d4e5f6)

get_recent​

Get the most recently ingested entries.

ParameterTypeRequiredDefaultDescription
limitnumberNo10Number of entries

search_by_category​

Browse entries by category.

ParameterTypeRequiredDefaultDescription
categorystringYes—Category name
subcategorystringNo—Subcategory filter
limitnumberNo20Maximum results

update_entry​

Update fields on an existing entry.

ParameterTypeRequiredDescription
entry_idstringYesEntry to update
titlestringNoNew title
contentstringNoNew content
tagsstringNoNew tags (comma-separated)

get_stats​

Get UB ingestion statistics.

No parameters.


Work Order API​

create_work_order​

Create a new work order.

ParameterTypeRequiredDescription
titlestringYesMust start with [Project-Category] prefix
assigneestringYesValid agent identity
projectstringYesProject name (e.g., SS1, SP)
descriptionstringNoDetailed work description
prioritystringNohigh, medium (default), low
due_datestringNoYYYY-MM-DD format
estimated_hoursnumberNoEstimated hours
acceptance_criteriastringNoWhat defines completion

list_work_orders​

Query work orders with filters.

ParameterTypeRequiredDefaultDescription
statusstringNo—Filter by status
projectstringNo—Filter by project
assigneestringNo—Filter by assignee
include_completedbooleanNofalseInclude completed/cancelled
limitnumberNo20Maximum results

accept_work_order​

Accept a pending work order.

ParameterTypeRequiredDefaultDescription
order_idstringYes—WO ID
assigneestringNoAutoAgent identity

update_work_order_status​

Change work order status (must follow state machine).

ParameterTypeRequiredDescription
order_idstringYesWO ID
new_statusstringYesTarget status
notesstringConditionalRequired for blocked/unblock

complete_work_order​

Submit work order for review.

ParameterTypeRequiredDescription
order_idstringYesWO ID
summarystringYesCompletion summary
actual_hoursnumberRecommendedHours spent

verify_work_order​

Approve or reject a work order (Captain only).

ParameterTypeRequiredDescription
order_idstringYesWO ID
approvedbooleanYestrue = approve, false = reject
notesstringNoReview comments

dispatch_work_order​

Dispatch a work order to an engine for execution.

ParameterTypeRequiredDefaultDescription
work_order_idstringYes—WO ID
enginestringNoclaudeEngine: groq, gemini, claude, ingest, etc.

Communication API​

agent_heartbeat​

Register agent as online.

No required parameters.

check_agent_mailbox​

Check agent's mailbox.

ParameterTypeRequiredDefaultDescription
agent_namestringNoAutoAgent identity
unread_onlybooleanNofalseOnly unread messages

send_agent_message​

Send a message to another agent.

ParameterTypeRequiredDescription
tostringYesRecipient agent identity
subjectstringYesMessage subject
bodystringYesMessage body (markdown)
prioritystringNonormal or urgent

factory_floor_status​

Get real-time overview of team status and active work.

No parameters.


Intelligence API​

Search any topic and auto-ingest findings into UB.

ParameterTypeRequiredDefaultDescription
querystringYes—Search query (English)
enginestringNogroqgroq (free) or gemini (citations)
tagsstringNo—Tags for ingested intel

search_web​

Delegate web search to low-cost engines.

ParameterTypeRequiredDefaultDescription
querystringYes—Search query
enginestringNogroqgroq or gemini

call_model​

Call a low-cost LLM for subtasks.

ParameterTypeRequiredDefaultDescription
promptstringYes—Prompt text
providerstringNogroqgroq, gemini, deepseek, mistral, zhipu
temperaturenumberNo0.3Creativity 0.0-1.0

Authentication​

All API calls are authenticated via environment variables:

VariablePurpose
SP_CLOUD_UB_URLCloud UB endpoint
SP_API_KEYAPI authentication key
SP_SHIP_IDShip identity (SS1, SS2, SS3)
SP_AGENT_IDAgent identity

PageRelationship
MCP Tool DiscoveryHow agents find tools
Agentic APIIndustry concept alignment
Setup MCPConfiguration guide