Skip to content

Onboard a teammate

Goal: a teammate clones your repo and their AI agents pick up the project’s MCP servers and conventions with minimal setup.

The lever here is the project-local overlay: a .agentsync.toml marker committed at the repo root.

  1. Add a project marker at the repo root and commit it:

    myrepo/.agentsync.toml
    agents = ["claude", "opencode"]
    [[mcp]]
    id = "company-api"
    type = "stdio"
    command = "npx"
    args = ["-y", "@company/mcp"]
    [plugins]
    disabled = ["screenshot"] # noisy for this repo
  2. Reference team secrets, don’t embed them. If company-api needs a token, reference it so each teammate supplies their own value locally:

    [[mcp]]
    id = "company-api"
    # …
    [mcp.env]
    COMPANY_TOKEN = "${secret:company.token}"
  3. Document the one-time setup in your repo’s README: install agentsync, set the team secret, then apply from inside the repo.

  1. Install agentsync (install guide) and set the shared secret locally:

    Terminal window
    agentsync secrets set company.token --stdin < token.txt
  2. Apply from inside the repo — the overlay merges onto their user config:

    Terminal window
    cd myrepo
    agentsync apply --dry-run
    agentsync apply