OpenFlare Agents Quick Start

# Install SDK directly from GitHub Repository:
npm install github:OpenFlareStudio/agents

# Or clone and build from source:
git clone https://github.com/OpenFlareStudio/agents.git
cd agents
npm install && npm run build

name = "my-web3-agent"
main = "src/index.ts"
compatibility_date = "2026-07-31"

[ai]
binding = "AI"

[[d1_databases]]
binding = "DB"
database_name = "my-d1-db"
database_id = "YOUR_D1_DATABASE_ID"

import { Agent, type Connection, type WSMessage, type AgentEnv } from "@OpenFlareStudio/agents";

export class Web3Agent extends Agent {
  constructor(env: AgentEnv) {
    super(env);
  }

  // 1. Triggered on connection establishment
  async onConnect(connection: Connection): Promise<void> {
    connection.send(JSON.stringify({
      type: "ready",
      status: "Connected to OpenFlare Studio Edge"
    }));
  }

  // 2. Triggered on incoming message or tool command
  async onMessage(connection: Connection, message: WSMessage): Promise<void> {
    const data = typeof message === "string" ? JSON.parse(message) : message;

    if (data.action === "audit_evm") {
      await this.setState({ last_contract: data.contract });
      const currentState = await this.getState();

      const result = await this.env.AI.run("@cf/meta/llama-3.2-3b-instruct", {
        prompt: `Audit Robinhood EVM contract: ${data.contract}`
      });

      connection.send(JSON.stringify({
        status: "success",
        state: currentState,
        result
      }));
    }
  }

  // 3. Triggered when client disconnects
  async onClose(connection: Connection): Promise<void> {
    console.log("Client disconnected:", connection.id);
  }
}

import { Agent, type Connection, type WSMessage } from "@OpenFlareStudio/agents";

export class CustomAgent extends Agent {
  // 1. Triggered when client establishes WebSocket / Session connection
  async onConnect(connection: Connection) {
    console.log("Client connected:", connection.id);
  }

  // 2. Triggered when user or subagent sends a message/tool command
  async onMessage(connection: Connection, message: WSMessage) {
    console.log("Received payload:", message);
  }

  // 3. Triggered when client disconnects
  async onClose(connection: Connection) {
    console.log("Client closed connection:", connection.id);
  }
}

Primary MCP Portal:   https://app.openflare.fun/api/mcp
Minimize Tools Mode:  https://app.openflare.fun/api/mcp?optimize_context=minimize_tools
Search & Execute:    https://app.openflare.fun/api/mcp?optimize_context=search_and_execute
Workers Code Mode:   https://app.openflare.fun/api/mcp?codemode=search_and_execute

cyberterm_history_<userId>
cyberterm_saved_sessions_<userId>
cyberterm_user_settings_<userId>
cyberterm_custom_skills_<userId>
cyberterm_custom_mcp_portals_<userId>

curl -X POST "https://app.openflare.fun/api/chat" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-3-5-sonnet",
    "messages": [
      { "role": "user", "content": "Compile liquidity contract on Robinhood EVM Chain 4663" }
    ]
  }'