@availsync/setup

One-command MCP setup for Availsync.

npx @availsync/setup
npx @availsync/setup test

The installer configures the public Availsync MCP server for local agent tools:

• Claude Code, by printing the safe claude mcp add command so you can choose the right Claude scope
• Codex, by updating ~/.codex/config.toml
• Cursor, by updating ~/.cursor/mcp.json
• Windsurf, by updating ~/.codeium/windsurf/mcp_config.json

Non-interactive usage

npx @availsync/setup \
  --agent-id "$AVAILSYNC_AGENT_ID" \
  --tools codex,cursor,windsurf \
  --yes

Set AVAILSYNC_API_KEY and AVAILSYNC_AGENT_ID in the environment before running non-interactively. Avoid putting raw API keys directly in shell history.

After setup, run a claim-free API connection check:

npx @availsync/setup test \
  --agent-id "$AVAILSYNC_AGENT_ID" \
  --resource repo:owner/repo

The test calls /v1/work/check, prints the availability status, and does not create a work claim. It still records normal API activity and updates the agent's last-seen timestamp. It verifies your Availsync API key and agent id; your MCP client still needs to be reloaded before it can discover the tools.

Add a second agent role by using a different server name and API key:

AVAILSYNC_API_KEY="$AVAILSYNC_REVIEWER_API_KEY" \
npx @availsync/setup \
  --agent-id "$AVAILSYNC_REVIEWER_AGENT_ID" \
  --name availsync_reviewer \
  --tools codex \
  --yes

Claude Code fast path

Claude Code can also be configured directly:

claude mcp add --transport stdio \
  --env AVAILSYNC_API_URL=https://availsync.dev \
  --env AVAILSYNC_AGENT_ID=AGENT_ID \
  --env AVAILSYNC_API_KEY=API_KEY \
  availsync -- npx -y @availsync/mcp

The setup CLI prints this command when claude is selected, so you can choose the right Claude scope explicitly.

Safety

• Existing JSON and TOML config files are updated idempotently.
• Existing files are backed up before they are changed.
• API keys are not printed in normal output. For one-command local setup, the key is stored in the selected local user-level MCP config. Keep these files out of repos and rotate the key if a machine is shared.
• Use --dry-run to preview changes without writing files.

Run npx @availsync/setup --help for all options.