Quickstart

1. Get an API key

Sign in at app.userintuition.ai and create a key under Settings → API Keys. Keys look like ui_sk_.... Copy it now — it is only shown once.

2. Install

One-shot (npx)
Global
Project-local

No install — runs the latest published version on demand:

npx -y @userintuition-ai/mcp list

Slower per-invocation (npm fetches metadata). Best for occasional use.

npm install -g @userintuition-ai/mcp
userintuition-mcp list

Installs once, then userintuition-mcp is on your PATH. Best for daily use.

npm install --save-dev @userintuition-ai/mcp
npx userintuition-mcp list

Pinned to your project’s package.json and lockfile. Best for CI and reproducible scripts.

3. Set your key

export USERINTUITION_API_KEY=ui_sk_your_key_here

Add this to your shell profile (~/.zshrc, ~/.bashrc) so it persists across sessions. For CI, set it as a secret environment variable.

4. Verify the connection

userintuition-mcp call list_studies

A JSON array (possibly empty) on stdout confirms the CLI, your key, and network egress to api.userintuition.ai are all working.

5. First real call

Estimate the cost of a small Human Signal study without spending any Panel budget:

userintuition-mcp call ask_humans \
  --mode preference \
  --text "Which tagline resonates more with busy parents?" \
  --options '["Save time, save money", "Less stress, more life"]' \
  --n 25 \
  --dry_run true

You should see an estimated cost on stdout. When you’re ready to actually field the study, change --dry_run false.

Next steps

Command reference

Full reference for list, describe, call, and every flag.

Recipes

CI cost gates, lifecycle scripts, batch operations.

Get Started

Reference

Guides

1. Get an API key

2. Install

3. Set your key

4. Verify the connection

5. First real call

Next steps

Command reference

Recipes

​1. Get an API key

​2. Install

​3. Set your key

​4. Verify the connection

​5. First real call

​Next steps

Command reference

Recipes

1. Get an API key

2. Install

3. Set your key

4. Verify the connection

5. First real call

Next steps