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.

Editor setup

Crush MCP Server

Fastest: npx -y zephex setup --crush (browser sign-in, writes crush.json). Or paste the mcp.zephex block below. Zephex uses https://zephex.dev/mcp with Bearer auth in the file — internet required.

Official Crush MCP documentation: Crush documentation

MCP endpointhttps://zephex.dev/mcp
AuthenticationAuthorization: Bearer mcp_sk_...
Config filecrush.json (project) or ~/.config/crush/crush.json

Why Zephex

Without MCP, your agent guesses project layout and misses supply-chain risk. Zephex connects one hosted endpoint so every session gets the same ten tools — no per-machine npm installs, no version drift across the team.

Before you start

  • Crush installed (Charm Bracelet — see their GitHub for install).
  • A Zephex API key from Dashboard → API Keys.
  • Network access to https://zephex.dev/mcp.
  • Know whether Crush is using project crush.json or the global config for your session.

Get and paste your API key

HTTP and stdio setups both need a key from your Zephex dashboard. OAuth-only flows (ChatGPT, Claude.ai web) sign you in in the browser instead — skip this section for those.

  1. Sign in at zephex.dev → Dashboard → API Keys (or /dashboard/api-keys).
  2. Click Create API key, give it a name you will recognize (e.g. "Kilo — work laptop"), then create.
  3. Copy the key as soon as it appears — Zephex only shows the full secret once. It starts with mcp_sk_ or a newer mcp_prod_… format.
  4. Paste into your config: either only the key in an env field (ZEPHEX_API_KEY), or the full HTTP header value Authorization: Bearer YOUR_KEY — match what your editor’s form asks for.
  5. Do not wrap the key in extra quotes inside JSON unless the file already quotes other string values.
  6. Never commit API keys to git. Revoke and create a new key in the dashboard if one leaks.

Setup policy for Crush

Matches the published CLI (mcp-proxy/src/commands/setup.ts). One command signs you in, writes the correct transport, and verifies 10 tools.

Recommended commandnpx -y zephex setup --crush
Project-scopednpx -y zephex setup --crush --project
TransportHosted HTTP (url + Bearer)
Config parent keymcp

Global vs project config

  • Global setup is the default — run setup without --project so Zephex works in every folder you open.
  • Global setup also removes stale project-level Zephex entries that shadow your user config.
  • Add --project only when you intentionally want workspace-scoped config (e.g. .cursor/mcp.json in one repo).

After setup

  • Setup writes HTTP type in crush.json — do not add stdio npx for the same zephex entry.

Account teardown: logout vs disconnect · Connect MCP walkthrough

Find where setup wrote your config

Search docs for “where is my MCP file” — the answer is always: run list first, then open the path it prints.

  1. Run npx -y zephex@latest list — canonical path list for crush.
  2. Wizard writes to: crush.json (project) or ~/.config/crush/crush.json (global)
  3. macOS uses ~/ and ~/.config; Windows uses %USERPROFILE% and %APPDATA%; Linux uses ~/.config.

Documented paths: crush.json (project) or ~/.config/crush/crush.json (global)

One command

Crush crush.json uses mcp.zephex with type http — matches Charm schema.

Guided install (matches published CLI)

Runs the same code as mcp-proxy/src/commands/setup.ts — OAuth in browser, creates a CLI key, writes your editor config, verifies tools.

shell
npx -y zephex setup --crush

Already have a key?

Skip browser OAuth — paste a key from zephex.dev/dashboard/keys. Must start with mcp_prod_, mcp_dev_, or mcp_sk_.

shell
npx -y zephex setup --crush --api-key mcp_prod_your-key-here

Guided install (matches published CLI)

Runs the same code as mcp-proxy/src/commands/setup.ts — OAuth in browser, creates a CLI key, writes your editor config, verifies tools.

shell
npx -y zephex setup --crush --project

What setup writes (global)

mcp.zephex HTTP block — merge into crush.json: Transport: http (see crush.json (project) or ~/.config/crush/crush.json (global)).

json
{  "$schema": "https://charm.land/crush.json",  "mcp": {    "zephex": {      "type": "http",      "url": "https://zephex.dev/mcp",      "headers": {        "Authorization": "Bearer mcp_sk_your_key_here"      }    }  }}

After CLI install, fully restart the app if tools do not appear. Manual JSON/TOML blocks below are equivalent — use them when CLI commands are unavailable.

Hosted HTTP vs npx stdio

  • Recommended: npx -y zephex setup --crush — Crush crush.json uses mcp.zephex with type http — matches Charm schema.
  • Config path: crush.json (project) or ~/.config/crush/crush.json (global)
  • Manual HTTP: url https://zephex.dev/mcp + Authorization Bearer mcp_sk_…
  • Optional stdio fallback: npx -y zephex with ZEPHEX_API_KEY if HTTP fails on your network.
  • Never keep two zephex entries (stdio + HTTP) in the same config — pick one transport.
  • Cloud-only tools (check_package, project_memory, audit_headers, keep_thinking, Zephex_dev_info) work on both transports.
  • Repo tools (get_project_context, read_code, find_code, explain_architecture, check_test) need either stdio/npx setup or an explicit github:owner/repo or absolute path on HTTP.

Full comparison: HTTP vs stdio · npx zephex reference

How to connect Zephex

Crush uses a top-level mcp key — not Cursor’s mcpServers wrapper. Wrong shape is the most common mistake.

  1. Copy your API key from the dashboard (Bearer + key goes in headers.Authorization in JSON).
  2. Decide scope: project crush.json in the repo you open in Crush, or global ~/.config/crush/crush.json for every directory.
  3. Open the file in an editor. If it does not exist, create it with { "mcp": {} } first.
  4. Merge the mcp.zephex block below; keep other MCP servers under mcp if you already have them.
  5. Replace mcp_sk_your_key_here in Authorization — include the word Bearer and a space before the key.
  6. Save, restart Crush or start a new agent session from the same working directory.
  7. In Crush’s MCP UI, confirm zephex is listed and enabled.
  8. Test from the project root you care about so path-based tools target the right folder.

Configuration

Replace mcp_sk_your_key_here with your key from Dashboard → API Keys. Copy the full key once at creation — paste into Authorization: Bearer … for HTTP configs, or into ZEPHEX_API_KEY for stdio/npx configs.

Remote server connection

Type must be "http". Do not use command/npx for Zephex — that runs a local process instead of the hosted endpoint.

json
{  "$schema": "https://charm.land/crush.json",  "mcp": {    "zephex": {      "type": "http",      "url": "https://zephex.dev/mcp",      "headers": {        "Authorization": "Bearer mcp_sk_your_key_here"      }    }  }}

Tip

Launch Crush from the project directory when you want project crush.json to apply; global config applies when no project file exists.

Verify, repair, disconnect (CLI)

Run these in a terminal when the editor UI is unclear — catches stale npm, wrong transport, and project shadows.

shell
npx -y zephex@latest listnpx -y zephex@latest doctornpx -y zephex@latest repair# Fully quit the editor (Cmd+Q / Alt+F4), reopen, start a new agent session

Repair policy

  • Hosted HTTP editors usually do not need repair — if auth fails, run reconnect or paste a fresh key from the dashboard.
  • Do not add a stdio npx block alongside url HTTP for the same zephex server.

Disconnect & skills

  • disconnect --<editor> removes Zephex from config files the CLI knows about and revokes the API key found in those files.
  • There is no disconnect --project flag — disconnect checks both global and project paths (project paths use your current terminal cwd).
  • Terminal-only sign-out: mcpcli logout (editors unchanged). Full teardown: mcpcli logout --all.
  • This editor: mcpcli disconnect --crush
  • Fresh OAuth: mcpcli reconnect --crush
  • Add agent guidance: mcpcli setup --crush --with-skill or mcpcli skills --<editor>.
  • Remove skills from one editor: mcpcli reset --crush (disconnect + skill files).
  • Remove all skill copies: mcpcli skills --remove.

Check that it works

After saving your config, confirm Zephex is connected before you rely on it in real work.

  1. Crush MCP panel lists zephex without error.
  2. Ask: “Use check_package on lodash” (no path).
  3. Ask: “Use get_project_context on this project” from repo root, or give /Users/you/repo or github:org/repo explicitly.
  4. 401 → fix Bearer header; empty project → add path in the prompt.

Common searches

Questions people ask when Crush does not show Zephex tools — indexed for docs search.

How do I connect Zephex to crush?

Fastest: npx -y zephex setup --crush (browser sign-in, writes config, verifies 10 tools). Or paste manual config on this page, save, fully quit the app, reopen.

Where did setup save my crush MCP config?

Run npx -y zephex@latest list — it prints every config path on this machine that references Zephex.

crush works in terminal but not in the editor

Confirm Bearer header and url https://zephex.dev/mcp. Revoke old keys and reconnect if you see 401.

How do I disconnect Zephex from crush?

mcpcli disconnect --crush — revokes key and strips config.

Example ways to use the tools

You do not call tools yourself — ask your agent in plain language. Try these once Zephex is connected:

“In Crush TUI, check_package on a Go module before go get in this Charm workspace.”

Terminal agent gets registry intel over HTTP MCP.

“get_project_context on the repo where crush.json lives.”

Stack snapshot for Bubble Tea / Go layouts.

“read_code the Update function in our view model — compact mode on.”

Small focused reads fit narrow terminal panes.

“find_code tea.KeyMsg handlers in this codebase.”

Idiomatic search for Charm ecosystem patterns.

“check_test: add config file hot-reload to our CLI.”

Minimal touch list before Crush edits multiple packages.

“audit_headers on our project's public demo URL.”

Quick security sanity check from the same session.

Which tools need your project path?

You do not pick tools from a menu — ask your agent in normal sentences. Half of the tools only need a package name or URL; the other half need to know which codebase you mean (your Mac/Windows project folder or a GitHub repo).

Need a repo or folder path

  • get_project_context — full stack snapshot for one repo
  • read_code — read functions/classes by symbol name
  • find_code — search definitions and usages
  • explain_architecture — Mermaid diagrams for the repo
  • check_test — minimal file list for a task you describe

Work without a local project

  • check_package — npm/PyPI/Cargo/Go registry safety (no repo path)
  • project_memory — Cross-session project memory: remember decisions, gotchas, goals, conventions across sessions via local SQLite (stdio only).
  • audit_headers — security grade for any HTTPS URL you own or may test
  • keep_thinking — structured debugging notes across steps
  • Zephex_dev_info — vetted patterns (auth, DB, deploy, etc.)

How to tell the agent where the code lives

  • GitHub (no clone required): say github:owner/repo — example: github:vercel/next.js
  • Local folder: give the absolute path to the project root (the folder that contains package.json, pyproject.toml, or go.mod).
  • If your editor already has the repo open, try “use get_project_context on this workspace” first; if the tool returns empty, repeat with the full path or github: URL in the same chat.
  • For read_code / find_code, name the symbol or search term in the same message as the path (e.g. “find_code AuthService in github:myorg/api”).

macOS and Windows paths

  • macOS example path: /Users/yourname/Developer/my-app
  • Windows example path: C:\Users\yourname\projects\my-app
  • Replace yourname with your Mac or Windows login — the agent cannot guess your home directory.
  • Cloud-only tools (check_package, audit_headers) never need your username or project folder.

When Zephex will not connect

These situations usually mean the setup cannot work until you fix the underlying issue:

  • No internet or a firewall blocks outbound HTTPS to zephex.dev (port 443).
  • API key never created, revoked, or pasted incorrectly (missing Bearer , extra quotes, or truncated copy).
  • Wrong MCP URL — must be exactly https://zephex.dev/mcp (not /docs, not /api, no wrong host).
  • Mixed stdio + HTTP — two zephex entries (npx and url) confuse many clients; keep one transport.
  • Corporate proxy strips Authorization headers or chunked transfer encoding.
  • Monthly request limit reached on the Free plan (555 requests/month) — tools stop until next cycle, share for bonus requests, or upgrade.
  • Editing the wrong config file — global vs project-level paths differ by editor and OS.
  • App not fully quit after save — MCP often loads only on a cold start (especially IDEs).
  • Tools connect but return “no project” — not a connection failure; add github:owner/repo or an absolute path (see tool usage section).
  • Node.js or npx not on PATH when the desktop app launches (common on macOS Dock launches).
  • Invalid JSON in the config file (comments, trailing commas, or wrong wrapper key).
  • ZEPHEX_API_KEY missing, still set to the placeholder, or pasted in the wrong field (stdio uses env, not Bearer headers).
  • You edited Claude Code’s config but opened Claude Desktop (different files).
  • App was not fully quit after saving the config — MCP only reloads on a cold start.
  • npx works in Terminal but not inside the app — use absolute paths to node/npx in the command block if needed.
  • First npx -y zephex run can take 30–60s — increase startup_timeout_sec where the editor supports it.
  • Still have an HTTP url block while testing stdio — remove the duplicate zephex server.

If something goes wrong

Wrong JSON shape

Use mcp.zephex at top level per crush.json schema — not mcpServers.

Config not loaded

Check project crush.json vs ~/.config/crush/crush.json. Restart Crush from the intended cwd.

401 Unauthorized

"Authorization": "Bearer mcp_sk_..." — quotes around the full header value in JSON.

type http not recognized

Update Crush to a build that supports HTTP MCP per Charm docs.

find_code returns nothing

Name the repo: github:owner/repo or absolute path on Mac/Windows in the same message.

Still stuck? Quickstart · MCP troubleshooting

Tools included with Zephex

Crush http MCP block unlocks ten developer tools in the TUI agent:

  • get_project_context

    Reads your project structure, dependencies, scripts, env vars, and framework markers in one call. Replaces manually opening package.json, tsconfig, and multiple config files at the start of every session.

  • read_code

    AST-based code extraction: pass a symbol name and get the implementation without reading entire files. Supports symbol lookup, batched file reads, and structural outlines for large files.

  • find_code

    Ranked search across the repo for definitions, usages, and patterns. Faster than blind grep when the agent does not know where a symbol lives.

  • check_package

    Live registry lookup for npm, PyPI, Cargo, and Go modules. Surfaces typosquat risk, maintainer changes, and suspicious version jumps before you run install.

  • explain_architecture

    Generates Mermaid diagrams for auth flows, service boundaries, and module dependencies so the agent reasons about structure instead of guessing.

  • check_test

    Turns a task description into the smallest file set to read or edit, with risk ratings and caller impact notes.

  • audit_headers

    Grades a deployed URL for CSP, HSTS, TLS, cookies, and redirects. Returns fix snippets for common hosts (Vercel, Cloudflare, Nginx).

  • keep_thinking

    Structured multi-step debugging: tracks hypotheses and conclusions so long investigations do not loop.

  • Zephex_dev_info

    Expert patterns for authentication, databases, frontend frameworks, deployment, and mobile stacks when the agent needs vetted guidance.

  • project_memory

    Persists decisions, gotchas, and conventions per project in ~/.zephex/memory (SQLite FTS5). recall before unfamiliar areas; remember after discoveries. Local stdio only on npx zephex.

Related

  • CLI setup (--crush) — paths by OS
  • Warp MCP setup
  • Hermes MCP setup
  • check_test reference
  • Quickstart — create your first API key
  • HTTP vs stdio — which to use
  • npx zephex setup commands
  • MCP troubleshooting
  • All supported editors
  • All 10 MCP tools
  • Install wizard
  • Pricing and limits