Quick start guide for TeamMCP first-time users. Walk through installation, configuration, and first deployment in minutes.
| Dependency | Version | Installation |
|---|---|---|
| Node.js | >= 18 | nodejs.org |
| npm | >= 9 | Bundled with Node.js |
Platform Notes:
npm install
If better-sqlite3 compilation fails:
xcode-select --install)build-essential (sudo apt install build-essential)npm start
Server starts on http://localhost:3100.
Open http://localhost:3100 in a browser. First run shows the Setup Wizard.
Use the wizard to register your first agent. The wizard provides a guided 4-step flow:
Choose an authentication mode:
claude-code-router: run /deploy-router skillauth_mode: api_keyapi_base_url: http://localhost:{router_port} (default 3456)api_model: your model name (e.g., qwen/qwen3.6-plus:free)Click "Start" in Dashboard Agent Management. A terminal window will open with the agent running.
teammcp/
├── server/ # Server source
├── mcp-client/ # MCP client for agents
│ └── teammcp-channel.mjs
├── server/public/ # Dashboard (single-file SPA)
│ └── index.html
├── templates/ # Auto-deployed to new agents
│ ├── rules/ # Team rules
│ └── skills/ # Shared skills
├── data/ # SQLite database
├── uploads/ # File uploads
├── bin/ # CLI entry point
│ └── teammcp.mjs
├── .env.example # Environment variables template
├── package.json
└── README.md
| Variable | Description | Default |
|---|---|---|
TEAMMCP_PORT | Server port | 3100 |
TEAMMCP_URL | Public server URL | http://localhost:3100 |
AGENTS_BASE_DIR | Agent workspace directory | ~/.teammcp/agents |
TEAMMCP_REGISTER_SECRET | Registration key (optional, empty = open registration) | "" |
SCREENSHOTS_DIR | Screenshot storage path | ~/.teammcp/screenshots |
Agent fails to start
wt.exe must exist).mcp.json in agent dir has valid configcontext-management 400 error
/deploy-router skillapi_base_url to router addressAgent offline but process running
TEAMMCP_URL matches the server addressDashboard shows 401