Quickstart

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

userintuition-mcp login

The CLI opens your browser, completes OAuth with PKCE on a temporary loopback callback, and saves the refreshable login in a private local credentials file.

userintuition-mcp auth status

Browser OAuth is best for interactive use. Existing USERINTUITION_API_KEY environments continue to work and take precedence over saved credentials.

3. Verify the connection

userintuition-mcp list_studies

A JSON object with a studies array (possibly empty) confirms the CLI, your login, and network egress to api.userintuition.ai are all working.

4. Create an API key for stdio or CI

After OAuth login, the CLI can create and save an organization-scoped key:

userintuition-mcp api-key create --name "My laptop"

The raw ui_sk_... key is returned once and saved locally with file mode 0600. Subsequent CLI calls and local stdio MCP sessions use it automatically. For CI, copy it into the USERINTUITION_API_KEY secret in your CI provider rather than copying the local credentials file.

5. First real call

Estimate the cost of fielding a panel for one of your studies without spending anything:

userintuition-mcp launch_panel \
  --study_id <your_study_id> \
  --target 25 \
  --incident_rate 50 \
  --country_code US \
  --dry_run true

You should see the cost and timeline estimate on stdout — no panel is provisioned and nothing is charged. Review and explicitly approve the complete study plan and estimate before changing --dry_run to 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. Install

3. Verify the connection

4. Create an API key for stdio or CI

5. First real call

Next steps

Command reference

Recipes

​1. Install

​2. Sign in

​3. Verify the connection

​4. Create an API key for stdio or CI

​5. First real call

​Next steps

Command reference

Recipes

1. Install

2. Sign in

3. Verify the connection

4. Create an API key for stdio or CI

5. First real call

Next steps