NexaLayer

السجل الرسمي الصحة

Managed proxy sessions, health, rotation, usage, and spend controls for AI agents.

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package @nexalayer/mcp
Claude Code
claude mcp add nexalayer -e 'NEXALAYER_API_KEY=<your nexalayer_api_key>' -e 'NEXALAYER_BASE_URL=<NEXALAYER_BASE_URL>' -- npx -y @nexalayer/mcp@0.2.0
إعداد JSON (Claude Desktop وCursor وVS Code)
{
    "mcpServers": {
        "nexalayer": {
            "command": "npx",
            "args": [
                "-y",
                "@nexalayer/mcp@0.2.0"
            ],
            "env": {
                "NEXALAYER_API_KEY": "<your nexalayer_api_key>",
                "NEXALAYER_BASE_URL": "<NEXALAYER_BASE_URL>"
            }
        }
    }
}

متغيرات البيئة

  • NEXALAYER_API_KEY إلزامي سري NexaLayer API key requested at https://nexalayer.net/agents?source=mcp-registry
  • NEXALAYER_BASE_URL Optional API base URL. Defaults to https://api.nexalayer.net/v1

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. NexaLayer Agent
  2. MCP Server
  3. Backend API
  4. Local Development
  5. Useful Commands
  6. Support (machine-readable)
  7. Chinese Docs and Examples
  8. Repository Origin

NexaLayer Agent

NexaLayer MCP Server — a Model Context Protocol (MCP) server that lets AI agents create and manage proxy sessions with budget guardrails.

The MCP implementation is in mcp/, with its source entry point at mcp/src/index.ts. The published package builds that file to the runtime entry path mcp/dist/index.js.

Current public starting prices are $0.23/GB for dynamic proxy sessions and $1.05/month for shared static proxy sessions. Exclusive static proxy sessions are $1.43–$5.86/month (launch pricing, live API authoritative). Query GET /v1/public/products or the authenticated product catalog for the current, authoritative quote and availability before creating a paid session.

MCP Server

Install

Run the published stdio server with npm:

npx -y @nexalayer/mcp

Or build and run the existing Docker image from the repository root:

docker build -t nexalayer-mcp ./mcp
docker run -i --rm \
  -e NEXALAYER_API_KEY="$NEXALAYER_API_KEY" \
  nexalayer-mcp

The Docker image uses stdio and does not expose a port.

Configure

Set NEXALAYER_API_KEY for API-backed tool calls. The server can start and expose initialize and tools/list without a key so MCP clients and directories can discover its capabilities. NEXALAYER_BASE_URL is an optional override.

Claude Desktop and Cursor both accept an mcpServers configuration like this:

{
  "mcpServers": {
    "nexalayer": {
      "command": "npx",
      "args": ["-y", "@nexalayer/mcp"],
      "env": {
        "NEXALAYER_API_KEY": "agk_your_key"
      }
    }
  }
}
Tools
ToolDescriptionCharges
nexalayer_list_productsList the compact, paginated catalog of available proxy products and current prices.No
nexalayer_create_sessionCreate a dynamic or static proxy session with an idempotency key. The create API does not honor include_credentials and omits proxy credentials. PRICE_MISMATCH (409): re-read prices, retry once. BUDGET_EXCEEDED and INSUFFICIENT_BALANCE (402): ask the owner, don't retry.Yes — deducts from the account balance
nexalayer_get_sessionRead one session. Credentials are omitted unless include_credentials=true; never log them.No
nexalayer_rotate_sessionRotate a dynamic session when health or telemetry recommends it. Credentials are omitted unless include_credentials=true; never log them.May affect paid usage
nexalayer_terminate_sessionTerminate a session and release its network resource; early termination does not imply a refund.No new charge
nexalayer_session_healthRead a session health score and rotation recommendation.No
nexalayer_session_usageRead traffic and request usage for a session.No
nexalayer_get_budgetRead spend limits, current spend, pause state, and daily reset.No
nexalayer_set_budgetSet API-key and daily spend limits, alerts, and pause behavior.No direct charge
nexalayer_usage_alertsRead actionable budget-threshold alerts.No
nexalayer_get_balanceRead the account balance and trial-credit state.No
nexalayer_list_transactionsList billing transactions for audit and reconciliation.No
nexalayer_check_statusCheck component status and incidents before retrying or filing a ticket.No
nexalayer_known_issuesList known issues with runnable workaround steps, filtered by error code.No
nexalayer_report_issueFile a support ticket; recent request ids and error codes are attached automatically.No
nexalayer_get_ticketRead a ticket's status, severity, events, and workaround.No

Transport: stdio.

See the mcp/ package README for packaging, Docker, pricing, and approval-policy details.

Backend API

The repository also contains the Agent Layer backend for NexaLayer, the Network Execution Layer for AI Agents.

This service exposes API-first capabilities for AI Agent, Playwright, Puppeteer, Browser-use, crawler, and automation workflows:

  • Agent account registration and API key authentication
  • Dynamic and static proxy session lifecycle management
  • Session telemetry, health scoring, and rotation recommendations
  • Billing, balance, recharge, transaction, and usage-facing endpoints
  • Natural-language agent routes for controlled proxy network operations

Local Development

npm install
cp .env.example .env
npm run db:generate
npm run dev

Useful Commands

npm run build
npm run lint
npm run test:unit
npm test
npm run test:phase0
npm run test:phase0:real
npm run test:phase0:static
npm run test:smoke

npm run test:phase0 is the safe profile. It validates registration, API key auth, product listing, balance, and transactions without creating a paid proxy session.

npm run test:phase0:real sets PHASE0_ALLOW_PAID=1 and creates one low-volume dynamic session, polls until active, explicitly requests credentials with include_credentials=true, checks proxy.full_url, reports telemetry, reads health and billing, then terminates the session in a cleanup step. Use NEXALAYER_PRODUCT_NO, PHASE0_QUANTITY, and PHASE0_PRINT_PROXY_URL=1 when you need a specific product or need to inspect the returned proxy URL.

npm run test:phase0:static creates one minimal static session, polls for proxy info, reports telemetry, reads health and billing, then terminates the session and releases the static resource. It is a paid smoke profile and should only be used in controlled environments.

The broader npm run test:smoke suite may create real Agent accounts, proxy sessions, orders, or billing records depending on environment configuration. Review docs/agentTest.md and the target environment before running it.

Session detail and rotation responses hide proxy.full_url by default. Send include_credentials=true only when the caller needs to connect, and never log the returned credentials. nexalayer_get_session and nexalayer_rotate_session pass that flag through. POST /sessions does not honor it, so nexalayer_create_session omits proxy credentials; read the session after it is active. Read measured traffic from GET /v1/sessions/{session_id}/usage. Unknown product numbers return HTTP 404 with PRODUCT_NOT_FOUND. PRICE_MISMATCH is HTTP 409: re-read prices, retry once. BUDGET_EXCEEDED and INSUFFICIENT_BALANCE are HTTP 402: ask the owner, don't retry.

Support (machine-readable)

API errors use an additive envelope: code, message, and details are unchanged, plus retryable, retry_after, suggested_action, side_effects, doc_url, known_issue_id, request_id, and a support contact. MCP tools return the same object in structuredContent with isError: true.

  • GET /v1/public/status: components, current state, and incident history (no key)
  • GET /v1/public/known-issues: known issues with workaround steps (no key)
  • GET /v1/public/errors and /v1/public/errors/{code}: error catalog (no key)
  • GET /v1/public/sla: early-access response targets, not guarantees (no key)
  • POST /v1/support/tickets, GET /v1/support/tickets/{ticket_id}: tickets scoped to the API key

Human contact: support@nexalayer.net (Telegram @LEWISMIN). If the upstream is down during terminate, billing stops at the first terminate attempt. See docs/SUPPORT.md for triage, response targets, alerts, and environment variables.

Chinese Docs and Examples

NexaLayer is not a raw proxy IP service. The Chinese MVP documentation presents it as a session-based network execution layer for Playwright, Puppeteer, Browser-use, AI browser agents, crawlers, and automation workflows.

Repository Origin

This code was split out from:

/Users/minzhenfa/sourceCode/wan-workspace/IPProxy/Agent

The intended GitHub repository is:

NexaLayer/nexalayer-agent

الأسئلة الشائعة

ما هو NexaLayer؟

Managed proxy sessions, health, rotation, usage, and spend controls for AI agents.

كيف أثبّت NexaLayer؟

يعمل على جهازك. في Claude Code: claude mcp add nexalayer -e 'NEXALAYER_API_KEY=<your nexalayer_api_key>' -e 'NEXALAYER_BASE_URL=<NEXALAYER_BASE_URL>' -- npx -y @nexalayer/mcp@0.2.0. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج NexaLayer إلى مفتاح API؟

نعم. يتطلب NEXALAYER_API_KEY، وتضبطها في إعداداته.

هل NexaLayer مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون NexaLayer؟

ينشره NexaLayer. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.