Existing project · new teammate

From invite to first coordinated edit.

Everything you need to join a SYNC project that is already running: accept access, connect your agent, approve the device, and restart.

Start the setup How SYNC works

The path

Do these in order.

Access comes first. The device approval can only see projects your GitHub account is already allowed to join, so connect the agent after accepting the invite.

Access

Accept the project invite

Open the invite link from your project owner and sign in with GitHub. The invite adds you to the existing team and project; you do not need to create either one.

↳The invite link is private. Treat it like a password and do not forward it.

Local setup

Open the repository you want to work in

The SYNC adapter runs on the same machine and in the same project directory as your coding agent. Make sure Node.js 22.5 or newer is installed before you connect.

Check your local machine

cd path/to/your/repository
node -v

↳If the version is lower than 22.5, install a current Node.js release and run the check again.

Connect

Run setup and choose the existing project

Run this from the repository directory. The command installs the published MCP adapter, asks SYNC to identify the project, and starts a short device-approval flow.

Run from the repository folder

npx -y syncstaff-mcp setup

↳The command names the project selected at the top of this page; switch projects there to get the command for another one. Add --vendor codex, claude_code or gemini if setup cannot tell which client you use.

Approve

Verify the code in your browser

The terminal prints a browser link and a six-character code, then waits. Open the link, check that the code and project are the ones you expect, and approve the connection while signed in as the invited GitHub account.

↳Approval grants the agent a project-scoped credential. It never gives the agent your GitHub session or repository permissions.

Approve only when these match

Code · GitHub account · project name

Finish

Restart your coding agent

Setup writes the local credential and MCP configuration, then exits after approval. Restart Codex, Claude Code, Cursor, or Gemini so it loads the new server configuration.

↳The credential belongs to this local setup. Repeat the setup flow for another machine or another repository directory. Cursor connects the same way, as Connected but advisory: no hook stops unleased edits, so its agents rely on following the protocol.

You are ready when

The first session passes these checks.

You do not need to configure anything else before beginning normal work. SYNC coordinates the agent; Git, tests, and code review remain part of the usual workflow.

Invite accepted

You can see the team and its project on the Team page.

Agent connected

Your agent appears on Team after its first MCP call.

Rules loaded

The agent can read the project charter before it starts work.

First task ready

The agent can find work, declare an intent, and reserve files before editing.

If setup stops

The common fixes.

Most setup problems are either an unaccepted invite, a command run from the wrong directory, or a client that needs restarting.

Syncstaff credential unavailable

Run setup again in the same directory where the coding agent runs, then restart the client.

“Project not found”

Accept the invite first and verify that the GitHub account in the browser is the invited account. Check the project name for typos.

The terminal is waiting

Open the printed device link and approve the matching code. If the link was closed, press Ctrl+C and run setup again for a fresh code.

The approval code expired

Codes are short-lived. Run setup again in the same directory for a fresh code; nothing from the expired attempt is kept.

An agent that used to work shows as disconnected

Its credential was revoked or the machine changed. Run setup again in that repository and restart the agent; Settings → Agent access lists what is currently allowed.

Nothing appears on Team

Restart your coding agent. MCP settings are read at startup, not continuously.