Runtime & Integrations

Runtime & 集成 Integrations

Codewhale is more than a terminal agent — it is a local control plane you can embed into your existing workflow through multiple protocols and integrations.

Trust boundary
Local-first

The Runtime API binds 127.0.0.1 by default. The local runtime does not require a Codewhale account or hosted relay.

Auth required

All Runtime API routes (/v1/*) require a Bearer token. Set CODEWHALE_RUNTIME_TOKEN env var or auth_token in config.toml.

Permissions user-controlled

Remote clients submit requests and approval decisions through the authenticated Runtime API. Local mode, permission posture, and sandbox policy still apply.

Open protocols

The HTTP/SSE Runtime API, MCP surface, and baseline ACP stdio adapter serve different integration needs; choose the interface your compatible client supports.

Integration surfaces

HTTP / SSE Runtime API

Full local HTTP + Server-Sent Events runtime API on 127.0.0.1:7878. Create threads, stream turns, manage background jobs, and control approval decisions — all from any HTTP client or the bundled mobile page.

ACP (Agent Client Protocol)

Baseline JSON-RPC adapter over stdio for compatible editor clients such as Zed. It supports initialize, new session, prompt, and cancel with text responses; shell and file tools, checkpoint replay, and session loading remain on the full Runtime API.

MCP (Model Context Protocol)

Connect Codewhale to external tools and services through configured MCP servers over stdio or HTTP/SSE, or expose Codewhale's own tools to another MCP client.

VS Code Extension

Phase 0 companion for the local runtime. It can open Codewhale in a terminal, start and check the Runtime API, and show read-only thread summaries and restore points. It does not yet provide full chat, inline edits, or editor actions.

Telegram Bridge

First-party Telegram bot bridge. Start a headless Codewhale session, then chat with it from any Telegram client — approvals, tool results, and completions surface inline.

Feishu / Lark Bridge

First-party Feishu / Lark bot bridge. Chat-native agent loop inside your Feishu workspace with approval cards, session linking, and audit trail.

Weixin Bridge (实验性)

Experimental Weixin / WeChat bridge. Receive agent completions and approvals inside WeChat; early-stage and not recommended for production deployments.

Detailed implementation docs: Runtime API and ACP stdio adapter ↗ · MCP integration ↗