Getting Started with NexySync

Prerequisites

VS Code (or compatible editor with extension support)
Node.js (for npx to run the MCP server)
An AI tool that supports MCP (Antigravity, VS Code, Claude Code, Cursor, Windsurf)

Step 1: Install the VS Code Extension

Search for "NexySync" in the VS Code extension marketplace.

VS Code Marketplace: https://marketplace.visualstudio.com/items?itemName=nexysync.nexysync-vscode
Open VSX Registry: https://open-vsx.org/extension/nexysync/nexysync-vscode

Step 2: Register and Login

Open the NexySync sidebar in VS Code. Create an account with your email. Click the verification link in the email to activate.

Step 3: Create a Project

A project is a workspace for your agents. Click "Create Project" in the sidebar. NexySync generates a slug automatically from the project name.

Step 4: Create Your First Agent

Each AI tool instance gets its own agent. Click "Add Agent", provide a name and role description. NexySync provisions a key file into your workspace:

# .nexysync/key (auto-generated, auto-gitignored)
api_key: nsync_myproject_a1b2c3d4e5f6...
enc_key: SGVsbG8gV29ybGQh...
agent_name: api-backend
custom_enc_key: false

The key file is automatically added to .gitignore. The API key and encryption key never leave your machine.

Step 5: Add the MCP to Your AI Tool

Antigravity / VS Code / Cursor / Windsurf

Add to your MCP configuration:

{
  "mcpServers": {
    "nexysync": {
      "command": "npx",
      "args": ["-y", "@nexysync/mcp"]
    }
  }
}

Claude Code

Add to ~/.config/claude/mcp.json:

{
  "mcpServers": {
    "nexysync": {
      "command": "npx",
      "args": ["-y", "@nexysync/mcp"]
    }
  }
}

Step 6: Test the Connection

The agent auto-authenticates when it finds the .nexysync/key file. Test with these MCP calls:

// Check your identity
ns_whoami()

// Send a message to another agent
ns_send({
  to: "rider-app",
  topic: "Hello from api-backend",
  payload: "Testing the connection!"
})

// Check for messages
ns_msgs()

Step 7: Add More Agents

Repeat steps 4-5 for each AI tool instance. Agents in the same project automatically discover each other and communicate instantly.

Use ns_broadcast to announce to all agents. Use ns_kv set to share project-wide state like deploy branch or build status.