Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.userintuition.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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

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.

​
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.