Skip to main content
This is the compact guide an agent should ingest before using SimpleFunctions.

Start sequence

sf describe --all --json
sf world --json
sf query "Fed rate cut" --json --limit 3
sf inspect KXRATECUT-26DEC31 --json

Safety classes

ClassMeaning
safe_readPublic read-only call
account_readAuthenticated user-scoped read
local_runtimeStarts or stops local process
server_writeMutates SimpleFunctions server state
exchange_writeCan place or cancel exchange orders

Tool discovery

sf describe --all --json
curl "https://simplefunctions.dev/api/contracts/tools"
curl "https://simplefunctions.dev/api/tools"
Use each catalog for its intended layer:
CatalogMeaning
sf describe --all --jsonLocal installed CLI command manifest.
/api/contracts/toolsStrict SDK/Agent canonical tool manifest.
/api/toolsBroad hosted compatibility inventory.
SDK and Agent SDK code should use canonical dotted names from /api/contracts/tools. Broad names such as get_world_state are not canonical SDK/Agent tools.

Preferred context strategy

SituationCall
New sessionsf world --json
Polling loopsf world --delta --json --since 1h
Topic searchsf query "<topic>" --json --limit 3
Market detailsf inspect <ticker> --json
Account memorysf me --json --detail --limit 10
Portfolio memorysf portfolio history --json --ticks 20 --trades 10 --since 2026-04-23

Error handling

Use the JSON contract. Do not scrape human terminal output.
sf query "Fed rate cut" --json
Errors should be structured and exit codes should classify the failure.