Quick Start
Start in Vruum Chat, install the official Vruum marketplace app in ChatGPT, or connect another agent with MCP and workflow skills.
Start in Chat to ask about your saved business records or prepare an email. You can revise the draft, approve its exact content, and inspect its delivery state in the same private conversation. Vruum keeps that conversation when you leave the page.
To use your own AI agent, follow the connection steps below. Continue with my agent in Chat copies the instructions for opening the same conversation. Copying the instructions does not start work or approve delivery.
ChatGPT: recommended setup
Open the official Vruum marketplace app and follow the installation and connection prompts shown there. ChatGPT setup does not require a local npm install or the Vruum CLI.
After connecting, start with a read-only prompt:
What needs my attention in Vruum today?The app bundles vruum-guide, deal-triage, and outreach-triage. Ask in
natural language and use the operations available in the connected app.
The manual MCP and local setup steps below are for other clients and advanced
setups.
Copy this for your agent
Install Vruum for me.
For ChatGPT, open the official Vruum marketplace app at
https://chatgpt.com/plugins/plugin_asdk_app_6abc0d085d088191820a73232f0b3189?open_in_app
and follow the installation and connection prompts shown there.
For another client, read https://vruum.ai/llms.txt and use its Vruum plugin if
available. Otherwise connect the Vruum MCP server at https://api.vruum.ai/mcp.
If this is a local coding harness without plugin support, connect the MCP and
install the skills with `npx --yes @vruum/skills@latest install`. Do not install
the Vruum CLI unless I ask for local-file, scripting, CI, or debugging features.
After setup, run a read-only check: What needs my attention in Vruum today?1. Choose the setup path
Use the highest path your harness supports:
| Path | Who should use it | What it does |
|---|---|---|
| ChatGPT marketplace app | ChatGPT users | Connects Vruum through the official marketplace app and bundles its ChatGPT skills. |
| Plugin | Most non-technical clients | Installs or connects Vruum as one unit: MCP tools, skills, and instructions where the harness supports them. |
| Direct MCP | Other hosted chat clients, MCP-aware harnesses, and advanced manual setups | Connects the agent to https://api.vruum.ai/mcp with your Vruum auth. |
| Optional local CLI | Technical users who need CI, local files, scripting, or auth debugging | Adds the vruum command tree and the convenience vruum init setup command. |
You do not need @vruum/cli to use Vruum. An MCP connection plus installed
skills is a complete setup. Node is needed only when using the npm skills
installer or the optional local CLI; plugin users do not need it.
2. Connect MCP manually
For clients using direct MCP, connect the server below. ChatGPT users can complete setup through the marketplace app above.
The Vruum MCP server is:
https://api.vruum.ai/mcpIf your harness supports remote MCP, connect that URL and authenticate with your Vruum account or token according to the harness.
After connecting, ask the harness:
List the Vruum MCP tools you can see, then call get_daily_briefing. If the
Vruum MCP server is missing, tell me which setup step is missing.For direct MCP clients, expected tools include get_daily_briefing, get_next_actions,
search, fetch, manage_person, manage_deal, manage_messages,
manage_outreach, manage_content, manage_settings, research,
import_prospects, inspect_assistant, manage_assistant, and skill.
ChatGPT exposes individual operations through its app; use the available app
operations for that connection.
3. Load skills
Vruum-shipped skills are packaged workflow instructions: pipeline fill,
outreach triage, engagement triage, deal review, enrichment, winback,
expansion, and content creation. They are separate from team skills saved in
Vruum and managed through the MCP skill tool.
ChatGPT loads its bundled skills through the marketplace app. The broader skills catalog describes the local skills package. If another harness supports plugins, the plugin should bundle MCP plus skills. If your local harness exposes a separate skill directory, install the Vruum skills package there:
npx --yes @vruum/skills@latest install
npx --yes @vruum/skills@latest install --target /path/to/skillsThe installer auto-detects Claude Code and Codex. On Windows it uses directory junctions, so it does not require Administrator access or Developer Mode. Restart the harness after installation so it discovers the new skills.
For a local harness with the skills package installed, ask the agent:
List the Vruum-shipped skills available to you, then invoke vruum-guide.See Plugin, MCP, and Skills for the split between packaging, live tools, and workflow instructions.
4. Optional local CLI
Skip this section for normal Vruum use. Install the CLI only when you need local
files such as CSV imports, shell scripting, CI, deterministic exit codes, auth
debugging, or the convenience of vruum init. It requires Node 22 or newer.
Install globally:
npm install -g @vruum/cli
vruum --helpOr run without installing:
npx @vruum/cli --helpCreate a Vruum token in Settings -> API tokens. Tokens start with
vk_live_. Store it locally:
vruum login
vruum whoami --jsonFor stateless CI or local agent scripts, skip the stored credential and use an environment variable:
export VRUUM_TOKEN=<your-vruum-token>
vruum whoami --jsonCodex MCP uses a separate runtime variable:
export VRUUM_MCP_TOKEN=<your-vruum-token>
codexVRUUM_TOKEN overrides the stored local credential for CLI calls.
VRUUM_MCP_TOKEN is the runtime token Codex reads for MCP. Users with access to
multiple companies can scope CLI calls with --for-company <company_id_or_exact_name>; over MCP, use the matching for_company
parameter.
Run setup from the project or workspace where you launch your local agent:
vruum initinit detects supported harnesses and configures what each can safely support.
Priorities:
- Claude Code: registers MCP and installs Vruum skills.
- Codex CLI: registers MCP and installs Vruum skills.
- Cursor, Cline, OpenCode, Windsurf, Gemini CLI: registers MCP when config is detected; skill placement depends on the harness.
init does not alter project-level AGENTS.md or CLAUDE.md files. Vruum
operating guidance comes from installed skills and plugin surfaces.
Use CLI Reference for the full local command tree.
5. Restart and verify local setup
Restart the harness so it reloads MCP and skills.
If you installed the optional CLI, you can also verify it locally:
vruum whoami --json
vruum skills list --json
vruum deal list --json6. First useful workflows
Start with one of these:
Use vruum-guide. Show my live account state, recommend the single next best
action, and hand off to the right specialist skill.Review the outreach queue and approve only the drafts that pass the quality bar.Fill pipeline for <segment>. Research fit before import and save only qualified
prospects.Review active deals, show stalled ones, and update next steps where the evidence
is clear.What the browser is for
After login, Work shows your priorities. Open the chat bar at the bottom of the page for private analysis and email preparation. Recent chats reopen saved conversations inside the same panel. Maximize it when you need more room. Chat currently supports permitted saved records, existing contacts, and eligible email mailboxes. It asks for missing scope and requires a separate exact email approval. It does not share your private conversation with teammates.
Work shows ranked Priorities and the Draft queue. Objectives holds revenue goals and their plans. Accounts, People, and Deals provide record history, research, and domain editors. Use these surfaces for structured work and review, and use Performance and Settings for measurement and configuration. Broader workflows remain available through their domain surfaces and connected-agent skills.
The nudge-copy loop
Every row on Actions carries a nudge chip: a ready-made, goal-first prompt for your connected agent. The loop is:
- Open
/actionsand scan the ranked actions. - Copy the chip on the card that needs attention.
- Paste it into your connected agent (Claude, Cursor, wherever you connected Vruum).
- The named skill runs. If your harness doesn't have that skill installed, the prompt already tells the agent to fall back to the underlying MCP tool, so it works either way.
One-line troubleshooting: if the agent says Vruum tools are unauthorized, reconnect Vruum in your harness's MCP settings.
Where to next
- MCP — hosted MCP setup and auth model.
- Plugin — plugin availability and fallback setup by harness.
- Skills — shipped skills, team skills, install paths, and workflow pages.
- CLI Reference — every command group and exit code.