Connect your agent

Your agent is deployed, but it has nothing to watch yet. To start sending events you need to install one client on your local machine and point it at your instance. Most users see their first event within 30 seconds of running the login command.

1. Choose your client

Pick one. You do not need all three — each sends the same events through the same gateway. If you are unsure, start with the CLI.

Client	Install	Best for
CLI	`@opensyber/cli`	Terminal-heavy devs, CI pipelines, scripted workflows
MCP Server	`@opensyber/mcp`	Claude Desktop, Cursor, any MCP-compatible AI client
VS Code Extension	`OpenSyber Connect`	Editor-native telemetry, inline event visibility

2. CLI install

The @opensyber/cli client is the fastest path. Node.js 18+ required.

01Install the CLI globally

npm install -g @opensyber/cli

02Get your gateway token

Open the dashboard, click your instance, and copy the token from the Connect panel. Treat it like a password.

03Log in from your terminal

opensyber login --token <your-gateway-token>

04Verify the connection

opensyber status

You should see connected and your instance ID. Events start flowing immediately.

3. MCP Server install

Use @opensyber/mcp to stream events from Claude Desktop, Cursor, or any MCP-compatible client.

01Install the MCP server

npm install -g @opensyber/mcp

02Add it to your Claude Desktop config

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "opensyber": {
      "command": "npx",
      "args": ["-y", "@opensyber/mcp"],
      "env": {
        "OPENSYBER_TOKEN": "<your-gateway-token>"
      }
    }
  }
}

03Restart Claude Desktop

Fully quit and reopen. The MCP server auto-starts and authenticates on the first tool call.

04Verify the connection

Ask Claude: "List my OpenSyber instances." If you see your instance ID, you are connected.

4. VS Code extension install

The extension surfaces events inline in the editor and runs entirely in the background. No terminal required.

01Install the extension

Open the Extensions panel (⇧⌘X) and search for OpenSyber Connect. Click Install.

02Open the command palette

Press ⇧⌘P (macOS) or Ctrl+Shift+P (Windows/Linux) and run OpenSyber: Connect Instance.

03Paste your gateway token

Copy the token from the dashboard Connect panel and paste it into the prompt. The extension stores it in the OS keychain.

04Verify the connection

The status bar shows OpenSyber: connected with your instance ID. Click it to open the live event feed.

5. Verify the connection

Open the dashboard and navigate to your instance. The Live Events panel should show events within 30 seconds of login. If the counter stays at zero for more than a minute, trigger something manually from your client to force a heartbeat:

opensyber ping

You can also confirm via the API:

curl -H "Authorization: Bearer <your-gateway-token>" \
  https://gateway.opensyber.cloud/v1/events?limit=5

6. Troubleshooting

Five things go wrong. They all have the same five fixes.

No token found

Open the dashboard, click your instance, and copy the Gateway Token from the Connect panel. Tokens rotate every 30 days — grab a fresh one if yours is older.

401 Unauthorized

The token is expired, revoked, or belongs to a different instance. Re-run the login command with a fresh token from the dashboard.

Network blocked (ECONNREFUSED / timeout)

Your firewall is blocking outbound HTTPS to gateway.opensyber.cloud on port 443. Allowlist that host or switch networks.

Events not appearing in the dashboard

Run `opensyber status` to confirm the client is authenticated. Check that the instance ID in your local config matches the one shown in the dashboard URL.

Wrong instance ID

If you have multiple instances, the CLI defaults to the first one. Pass `--instance inst_abc123` explicitly or run `opensyber use inst_abc123` to set the default.

Still stuck?

Head back to your dashboard and open the Connect panel — it shows your live token, instance ID, and the latest heartbeat timestamp.