@sperax/tool-sperax-alerts

Manage price, portfolio, and DeFi alerts with smart notifications

Sperax Alerts is an agent tool from SperaxOS, packaged headless so you can call it from any agent framework. It ships two things: the manifest — a JSON-Schema function definition a model can call — and the executor that runs the call against the real API.

There is no UI layer and no framework lock-in. It works anywhere TypeScript runs.

Install

npm install @sperax/tool-sperax-alerts

Usage

Call it directly

import { alertsExecutor } from '@sperax/tool-sperax-alerts';

const result = await alertsExecutor.invoke('createAlert', {"conditions":"<conditions>","name":"<name>"}, {
  messageId: 'msg-1',
});

console.log(result.content); // prose summary written for the model to read
console.log(result.state);   // typed data payload for your own UI

Give it to a model

import Anthropic from '@anthropic-ai/sdk';
import { AlertsManifest, alertsExecutor } from '@sperax/tool-sperax-alerts';

const client = new Anthropic();

const response = await client.messages.create({
  model: 'claude-opus-4-8',
  max_tokens: 1024,
  messages: [{ role: 'user', content: 'Ask something this tool can answer' }],
  tools: AlertsManifest.api.map((api) => ({
    name: api.name,
    description: api.description,
    input_schema: api.parameters,
  })),
});

for (const block of response.content) {
  if (block.type !== 'tool_use') continue;
  const result = await alertsExecutor.invoke(block.name, block.input, { messageId: response.id });
  console.log(result.content);
}

AlertsManifest.api is already in JSON-Schema form, so it maps onto any tool-calling API — Anthropic, OpenAI, the Vercel AI SDK, or an MCP server — without translation.

Every executor returns a BuiltinToolResult — { success, content, state }. content is prose written for the model to read; state is the typed data payload for your own code. Executors never throw: a failed call comes back as { success: false, content: '<reason>' }, so a network blip degrades the answer instead of crashing the agent loop.

Configuration — required

This tool needs a backend you control. It will not work on a bare npm install alone.

The upstream API requires a secret key. That key is deliberately not bundled here — shipping it in an npm package would leak it to every consumer. Instead the executor calls a SperaxOS /webapi/* route, which holds the key server-side and injects it. That route is session-authenticated, so the public deployment at https://chat.sperax.io (the default origin) answers 401 to anonymous callers.

To use this tool you need one of:

• a SperaxOS deployment of your own, or
• any HTTP endpoint that implements the same request shape and supplies the key.

Point the package at it before importing the tool — the URL is resolved once, when the module first loads:

SPERAX_API_BASE_URL=https://my-speraxos.example.com

or in code:

import { configureSperaxApi } from '@sperax/agent-tools-core';

configureSperaxApi({ baseUrl: 'https://my-speraxos.example.com' });

// import the tool only after configuring, so the path resolves against your origin
const { alertsExecutor } = await import('@sperax/tool-sperax-alerts');

Inside a browser that already serves those routes at its own origin, requests stay same-origin and no configuration is needed.

If you want a tool that runs with zero setup, use one of the standalone tools — those call public APIs directly and need no key, no origin, and no backend.

Tool identifier

sperax-alerts

API reference

createAlert

Create a new price, portfolio, or DeFi alert with customizable conditions and notification method.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | conditions | array | yes | Array of conditions: { target: string, comparator: "gt"|"lt"|"eq"|"gte"|"lte", threshold: number } | | name | string | yes | Human-readable name for this alert | | notificationMethod | string | no | Notification method: email, push, or in-app (default: in-app) | | type | string | yes | Alert type: price, portfolio, or defi |

listAlerts

List all alerts with their current status. Optionally filter by status.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | status | string | no | Filter by status: active, triggered, expired, paused |

deleteAlert

Delete an alert by its ID.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | alertId | string | yes | The ID of the alert to delete |

getAlertHistory

Get history of triggered alerts with timestamps and outcomes.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | limit | number | no | Maximum number of history entries to return (default: 20) |

updateAlert

Update an existing alert — modify its conditions, name, or notification method.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | alertId | string | yes | The ID of the alert to update | | conditions | array | no | Updated conditions array | | name | string | no | Updated alert name | | notificationMethod | string | no | Updated notification method |

Types

Shared types come from @sperax/agent-tools-core: BuiltinToolManifest, BuiltinToolResult, BuiltinToolContext, and the BaseExecutor class every tool executor extends.

Related

• @sperax/agent-tools-core — the tool contract
• All SperaxOS agent tools — tool-sperax-alerts is one of many
• SperaxOS — the agent workspace these tools were built for

License

Apache-2.0