zephex
CLIGet StartedPricingMCP ToolsCommunityGuidesDocs
←BackSign in
CLIGet StartedPricingMCP ToolsCommunityGuidesDocs
Get started freeSign in
DocsAPIToolsEditorsChangelogHelp

GET STARTED

WelcomeQuickstartSetup videoMCP Q&A (learn)BlogWhat is MCP?Who is Zephex for?Plans & PricingZ-GASAB benchmarkBenchmark chart (live)Changelog

INSTALLATION

Web Terminal tools (plain English)Terminal tools (complete)Connect MCPVS Code Marketplace extensionCLI (no AI agent)CLI init (first run)CLI account & logoutNPX (Recommended)Test Pulse (check test)Test Pulse commandsProject MemorySupply Pulse (supply)Supply Pulse commandsTerminal CLI referenceSlash commands (37 palette)Web Terminal (dashboard)Command CompassCLI commandsCLI in DockerCLI: All editors (one command)CLI: Crush, Hermes, ChatGPT, KiloOAuth & HTTP setupInstall overviewHTTP APISetup WalkthroughHTTP vs stdio

API & KEYS

API Key ManagementKey Naming & FormatAuthenticationKey Dashboard

CONFIGURATION

Universal RequirementsSupported EditorsHow It WorksArchitectureCLAUDE.md TemplateAGENTS.md Template

EDITORS28 guides

Supported EditorsVS CodeVS Code extension (Marketplace)Claude CodeCursorWindsurfJetBrains

PLATFORM

macOSWindowsLinux

TOOLS10 tools

Capabilities OverviewTools OverviewTool FilteringTool Workflowsget_project_contextread_codefind_codecheck_packageexplain_architectureZephex_dev_infocheck_testaudit_headerskeep_thinkingproject_memory

GUIDES

Best PracticesToken EfficiencyUse CasesZephex vs Local MCPZephex vs Context7Zephex vs GitHub MCPZephex vs SmitheryMCP EcosystemMarkdown Access

SUPPORT

Help CenterMCP troubleshootingTeam rolloutFAQConnection IssuesRate LimitsDowntime & ErrorsBillingTier GuidePro & Max guideUsage LimitsUsage Analytics

LEGAL

System StatusTerms (summary)Privacy (summary)Data UseSecurityAuthenticationSecurityData HandlingPrivacy PolicyTerms of Service

Quick Links

API Reference

Complete API documentation

Troubleshooting

Common issues and solutions

Community

Join our Discord community

Plugins

Editor and CLI integrations

Pricing

Free, Pro, and Max plans

Enter
Zephex_devzephex-devzephexzephexhello@zephex.dev
© 2026 Zephex. All systems operational.

Installation

Setup Walkthrough

What actually happens when you run npx zephex setup. Every step diagrammed, every prompt explained, every file written. Target: working MCP in ~90 seconds with 10 tools at https://zephex.dev/mcp.

Tip: Skip the interactive picker with a flag — npx -y zephex@latest setup --cursor goes straight to OAuth and config write. See npx zephex for all flags.

THE BIG PICTURE
01

Run setup

npx downloads zephex (~1.4MB) and starts the wizard.

02

Pick editor

Interactive picker or --cursor / --vscode flag.

03

Browser OAuth

Sign in at zephex.dev — CLI polls for the API key.

04

Write config

HTTP for Cursor/Claude; stdio for VS Code and others.

05

Restart & verify

Quit editor fully; confirm 10 tools.

diagram — end-to-end setup flow
┌──────────────────────────────────────────────────────────────────┐
│  npx zephex setup  →  picker  →  OAuth  →  config  →  restart   │
│       │                  │          │         │           │      │
│       ▼                  ▼          ▼         ▼           ▼      │
│   npm download      editor/scope  browser   writes     10 tools │
│   (~1.4MB)          /mode pick    sign-in   mcp.json   in editor │
└──────────────────────────────────────────────────────────────────┘
How setup signs you in (one browser visit)
Terminalnpx zephex setupzephex.devPOST /api/cli/sessionBrowser/cli/authDashboardGitHub / GooglePollGET /pollsession_idopen URLOAuthkey readyEditor MCP filestdio or HTTP~/.zephexcredentials.jsonapi_keys rowuser_id + HMACwriteswritescreatesEmail shown once at setup — not stored in credentials.json (use dashboard for account)

Stdio editors never re-auth per tool call — the API key is written once into config env. HTTP editors (Cursor) store Bearer in headers.

STEP 1 — RUN THE COMMAND

One command, no global install required

npx downloads the latest zephex package from npm and runs it. No global install needed — though npm install -g zephex gives you shorter mcpcli commands.

shell
npx -y zephex@latest setup

Prefer manual JSON? See Quickstart.

STEP 2 — THE PICKER

The CLI shows a 3-step picker. Each step explains what it does so you don't have to guess.

diagram — interactive picker (step 2)
◆  Which editor?     → Cursor, Claude Code, VS Code, Windsurf, …
◆  Where available?  → All projects (global) or This project only
◆  Agent mode?       → MCP + Skill + Rule (recommended) or MCP only
Terminal window running npx zephex setup showing the interactive editor picker

Screenshot — the npx zephex setup wizard with editor, scope, and mode selection.

2A — EDITOR

20+ options. Arrow keys, type to filter, or press 1-9 / a-j to jump. Flags like --cursor skip this step.

2B — SCOPE

Shown only in a real project (package.json, .git, etc.). Global vs project-local config. Auto-skipped in home or /tmp.

2C — MODE

MCP + Skill + Rule installs SKILL.md and rules that teach the agent when to call tools. MCP only writes the connection config.

STEP 3 — BROWSER OAUTH
diagram — browser OAuth polling
CLI opens zephex.dev/cli/auth?session=xxx
Terminal polls /api/cli/poll every 2s until sign-in completes
Browser creates API key → CLI receives key → writes config
text
https://zephex.dev/cli/auth?session=01jx8m...

Sign-in methods

  • GitHub (recommended for developers)
  • Google

What the browser does

  1. Creates a new API key for your account
  2. Marks the CLI session complete with that key
  3. Shows "You can close this tab"

Common mistake: Closing the terminal while waiting for sign-in. Keep the terminal open — the CLI polls every 2 seconds until the browser completes OAuth.

STEP 4 — CONFIG FILE

Once the CLI receives the API key, it writes the editor-specific config. Paths vary per editor:

diagram — config file paths per editor
Cursor        ~/.cursor/mcp.json          ./.cursor/mcp.json
Claude Code   ~/.claude.json              ./.mcp.json
VS Code       —                           ./.vscode/mcp.json
OpenCode      ~/.config/opencode/...      ./opencode.json
Windsurf      ~/.codeium/windsurf/...     —

Example — what the CLI writes for Cursor (hosted HTTP):

json
{  "mcpServers": {    "zephex": {      "url": "https://zephex.dev/mcp",      "headers": {        "Authorization": "Bearer mcp_prod_priv-1234.your-secret-here"      }    }  }}

Codex uses TOML, VS Code uses a servers key, Antigravity uses serverUrl. The CLI handles all formats — see HTTP vs stdio.

STEP 5 — SKILL + RULE (OPTIONAL)
diagram — skill and rule file paths
Cursor       ~/.cursor/skills/zephex/SKILL.md    ~/.cursor/rules/zephex.md
Claude Code  ~/.claude/skills/zephex/SKILL.md    ~/.claude/rules/zephex.md
OpenCode     ~/.agents/skills/zephex/SKILL.md    AGENTS.md block

The skill file teaches the agent when to call Zephex tools. Without it, tools are visible but the agent may not use them at the right times.

STEP 6 — RESTART THE EDITOR
diagram — terminal success output
◇  Signed in as you@example.com
◇  API key created: cli-2026-05-24
◇  Config written to ~/.cursor/mcp.json
◇  Skill installed at ~/.cursor/skills/zephex/SKILL.md
└  Done! Restart Cursor and you'll see Zephex tools in the tool list.

Important: a window reload is not enough for most editors. Quit completely (Cmd+Q on Mac, fully exit on Windows/Linux) and reopen.

STEP 7 — VERIFY
shell
npx -y zephex@latest status
text
EDITOR              CONFIG                    KEY              STATUS  TOOLS  DETAIL------------------  ------------------------  ---------------  ------  -----  ------Cursor (global)     ~/.cursor/mcp.json        mcp_prod_pri...  PASS    10     ok

If STATUS is PASS and TOOLS is 10, your editor is connected. Also run npx zephex doctor.

WHAT IF SOMETHING GOES WRONG?
diagram — quick fixes
Browser didn't open     → Open the URL the CLI printed
Stuck on sign-in > 5m   → Check internet, retry setup
Tools don't appear      → Quit editor fully (Cmd+Q)
401 Unauthorized        → npx zephex reconnect
Network errors          → npx zephex doctor

Full guide: MCP troubleshooting · npx zephex (doctor, repair, list).

COMPLETE TIMELINE
diagram — 90-second timeline
0:00  npx zephex setup
0:03  Picker — pick editor, scope, mode
0:14  Browser OAuth at zephex.dev/cli/auth
0:22  CLI receives key, writes config + skill
0:25  "Done! Restart Cursor."
0:35  Reopen editor → ask agent to use find_code
Total: ~90 seconds end to end
ABOUT THE API KEY

FORMAT

mcp_prod_priv-1234.abc123def456…

ON DISK

Editor config file + ~/.zephex/credentials.json

ON SERVER

HMAC-SHA256 hash with per-key salt — plain text never stored after creation

shell
npx zephex keysnpx zephex reconnect
WHERE TO NEXT

CLI commands

Every command and flag

Connect MCP

Editor flags and verify flow

Quickstart

Manual JSON config path

Supported editors

Config paths for all 22+