When To Use This Skill

Use this when the user asks for a capability you do not have natively and it may require external APIs or paid tools, including:

image/video/audio generation
speech-to-text / text-to-speech
web/news/social search
scraping/extracting URL content
maps/location/place lookup
data enrichment and people/company lookup

MCP / Plugin Tools

If MCP/plugin tools are available, prefer:

ferrite_configure
ferrite_search
ferrite_use
ferrite_status

When running via the OpenClaw plugin, Ferrite injects turn-level routing guidance so the agent prefers Ferrite discovery/use for external API tasks.

Playbook (Default)

npx @jpbonch/ferrite search "<user intent>"
Pick the best matching service and open its skill_url.
Use the exact URL/method/headers/body from that skill file with npx @jpbonch/ferrite use <url>.
If auth/setup is missing, run npx @jpbonch/ferrite configure and continue after completion.

Setup

npx @jpbonch/ferrite configure

This opens a URL for gateway configuration (billing + connections) and stores credentials in ~/.ferrite/credentials.json. It does not require adding a card to start using services.

Commands

Use

npx @jpbonch/ferrite use <url>

<url> must be a direct HTTPS URL.

Options:

--method <method> HTTP method
--header <key:value> repeatable header
--body <json-or-text> request body

Examples:

npx @jpbonch/ferrite use https://api.exa.ai/search \
  --method POST \
  --header "content-type:application/json" \
  --body '{"query":"latest robotics news","numResults":5}'

Search

npx @jpbonch/ferrite search <keywords>

Returns up to 5 matching services with domain and skill link.

Status

npx @jpbonch/ferrite status

Shows weekly budget, spend, remaining budget, and recent charges.

Configure

npx @jpbonch/ferrite configure

Opens configuration for billing, budget, and connected auth providers. Billing can be added later; usage accrues until the no-card allowance threshold is reached.

Spending Controls

Weekly budget enforced server-side.
Up to $5.00 of no-card accrued usage is allowed before billing setup is required.
Target domain must match an active service domain in Ferrite.

Common Errors

WEEKLY_BUDGET_EXCEEDED — weekly limit reached.
PAYMENT_METHOD_REQUIRED — no-card usage threshold or billing hold reached; run configure and add/update payment method.
SERVICE_DOMAIN_NOT_REGISTERED — target domain is not registered as an active service domain.
SERVICE_AUTH_REQUIRED — required OAuth connection missing; run configure and connect provider.

ferrite