nexoxa-bridge-sdk
v0.1.2
Published
TypeScript client for the local Nexoxa Bridge MCP API — databases, SSH, SFTP, SMTP, S3, analytics
Maintainers
Readme
nexoxa-bridge-sdk
TypeScript client for the local Nexoxa Bridge MCP API (http://127.0.0.1:<port>/api/bridge/v1/).
Connect by saved connection name — connection URLs never leave the encrypted Bridge registry.
Install
npm install nexoxa-bridge-sdkUsage
import { BridgeClient } from "nexoxa-bridge-sdk";
const bridge = new BridgeClient();
const { connections } = await bridge.listConnections();
// [{ id, name, engine, updatedAt }] — no URLs
await bridge.connectByName("Production Postgres");
await bridge.query("SELECT count(*) FROM users");
await bridge.serverDashboard("deep"); // ssh:// connection
await bridge.analyticsOverview({ framework: "nextjs", range: "7d" });
await bridge.storageList("/uploads"); // sftp:// or s3://
await bridge.smtpVerify(); // smtp:// connectionAPI surface
| Method | Bridge route |
|--------|----------------|
| listConnections() | GET connections |
| connectByName(name) | POST connect |
| connectActive() | POST connect/active |
| query, explain | POST query, explain |
| listSchemas, listTables, tableMetadata, tableRows | schema tools |
| kgReport, kgSummary, kgRefresh | knowledge graph |
| advisorsSecurity, advisorsPerformance, activeQueries | Postgres advisors |
| serverDashboard, serverExec, serverKg | SSH |
| analyticsOverview | GET analytics/overview |
| storageList, storageOverview, storageBuckets, … | S3/SFTP/FTP |
| smtpVerify, smtpOverview, smtpSend | SMTP |
Environment
| Variable | Purpose |
|----------|---------|
| NEXOXA_BRIDGE_URL | Override base URL |
| NEXOXA_BRIDGE_PORT | Override port (default 47821 desktop, 8080 dev) |
| NEXOXA_MCP_TOKEN | Optional localhost API token |
| NEXOXA_BRIDGE_SESSION | Pre-set session id |
Related
- nexoxa-mcp — MCP server for Cursor
- @nexoxa/analytics — web analytics SDK
- @nexoxa/speed-insights — speed insights SDK
- nexoxa-sdk — Nexoxa cloud API (
api.nexoxa.com)
Docs: asteron.nexoxa.com/integrations
MIT
