Skip to main content

MCP Setup

Step 1 — Install Node.js​

The Veyo MCP server runs through npx, which ships with Node.js. Install Node.js (LTS) on the machine where you'll run your AI client before going any further.

Download from the official site: https://nodejs.org/en/download

  • Windows — download the .msi installer and run it. Accept the defaults.
  • macOS — download the .pkg installer and run it, or brew install node.
  • Linux — use your distro's package manager (e.g. sudo apt install nodejs npm) or follow the instructions on the download page for your distribution.

Verify the install by opening a new terminal and running:

node -v
npx -v

Both commands should print a version number.

Step 2 — Generate an API key​

Generate an API key from the Veyo Cloud Portal. Every example below assumes you'll replace YOURAPIKEYHERE with that key.

Step 3 — Configure your client​

Pick the client you use:

Each page covers configuration at two scopes:

  • Project scope — useful when you maintain multiple similar projects and want a different API key per project (for example, when keys are scoped to specific Veyo Projects).
  • User scope — the simplest option. Veyo tools become available automatically in any project you open, but always query the same Veyo project. Switch projects by updating the Default Project on your Veyo dashboard.