@autokap/mcp
v1.6.6
Published
AutoKap MCP server — exposes AutoKap tools to MCP clients (Claude Code, Cursor, Codex, Windsurf, etc.)
Readme
@autokap/mcp
The official AutoKap MCP (Model Context Protocol) server. Lets AI coding assistants drive AutoKap — listing projects, creating presets, starting captures, fetching usage — directly from their IDE chat.
Install
# Claude Code (one-liner)
claude mcp add autokap -- npx -y @autokap/mcpFor Cursor / Codex / Windsurf / Cline / Continue, drop this snippet into the IDE's MCP config (path varies — see the per-IDE guides):
{
"mcpServers": {
"autokap": {
"command": "npx",
"args": ["-y", "@autokap/mcp"]
}
}
}Per-IDE guides live in the main repo
under docs/install-*.md.
Authenticate
Get an API key from autokap.app/api-keys, then from the IDE chat:
autokap_authenticate({ apiKey: "ak_cli_..." })This persists the key to ~/.autokap/config.json (chmod 0600 on POSIX).
Tools
The server exposes 34 tools across these groups (canonical list lives in
packages/mcp/src/tools/index.ts and is asserted by
server.integration.test.ts):
- Auth & diagnostic (5):
autokap_authenticate,autokap_whoami,autokap_logout,autokap_get_setup_url,autokap_doctor - Projects (3):
autokap_list_projects,autokap_get_project,autokap_create_project - Presets (6):
autokap_list_presets,autokap_get_preset,autokap_get_preset_info,autokap_create_preset,autokap_update_preset,autokap_delete_preset - Captures, sync listing + async run (5):
autokap_list_captures,autokap_get_usage,autokap_start_capture,autokap_check_capture,autokap_start_auto_recapture - Endpoints (3):
autokap_list_endpoints,autokap_get_endpoint,autokap_export_endpoints - Branding (2):
autokap_import_branding,autokap_export_branding - Video (2):
autokap_create_video,autokap_update_video - Credentials (5):
autokap_list_credentials,autokap_create_credential,autokap_upload_credential_session,autokap_update_credential,autokap_delete_credential - Proxy (2):
autokap_register_proxy,autokap_verify_proxy - Skill fallback (1):
autokap_get_skill(returns the canonical preset-creation skill as markdown when the client can't read MCP resources directly)
Resources & prompts
- Resource
autokap://skill/preset-spec— the canonical AutoKap preset creation skill (78 KB compiled markdown). Use this resource (or theautokap_get_skilltool fallback) to make any IDE assistant feature-aware before you ask it to author a preset. - Prompt
autokap-create-preset({ projectId?, projectUrl? })— guided workflow that points at the skill resource and the tools to call. Useful to bootstrap a new-preset session.
Async capture pattern
autokap_start_capture spawns the bundled autokap CLI binary as a detached
child process and returns a jobId in <1s. Poll with
autokap_check_capture({ jobId }). Job state is tracked in
~/.autokap/jobs/<jobId>/ (POSIX chmod 0700).
The autokap binary ships as an npm dependency of @autokap/mcp and is
resolved automatically — no second install step. The first capture installs
Chromium via Playwright on demand (≈300 MB, one-time); subsequent captures
reuse the local cache.
Env vars
| Var | Purpose |
|---|---|
| AUTOKAP_API_KEY | API key (alt to autokap_authenticate). |
| AUTOKAP_API_BASE_URL | Override the AutoKap server. Defaults to https://autokap.app. |
| AUTOKAP_CLI_BIN | Override the bundled autokap binary path (e.g. point at a globally installed copy). Rarely needed. |
| AUTOKAP_RUN_TOKEN | Cloud Run ephemeral token (CI use). |
| AUTOKAP_ALLOW_UNSAFE_SERVER_ORIGIN | Set to 1 to allow AUTOKAP_API_BASE_URL to point outside https://autokap.app / http://localhost:3000. |
| PLAYWRIGHT_BROWSERS_PATH | Honored by autokap_doctor for the Chromium cache check. |
License
ISC. © AutoKap.
