Skip to main content
Python dependency commands on this page use a PM-prepared source checkout. After a dependency change, reactivate the checkout and restart Mibyan. Mibyan can run as an ACP server, letting ACP-compatible hosts talk to Mibyan over stdio. Editors can render:
  • chat messages
  • tool activity
  • file diffs
  • terminal commands
  • approval prompts
  • streamed thinking / response chunks
Other hosts can use the same protocol to route collaboration events into Mibyan. ACP is a good fit when you want Mibyan to keep its existing identity, provider setup, memory, skills, and tools while another application owns the conversation transport.

What Mibyan exposes in ACP mode

Mibyan runs with a curated mibyan-acp toolset designed for editor workflows. It includes:
  • file tools: read_file, write_file, patch, search_files
  • terminal tools: terminal, process
  • web/browser tools
  • memory, todo, session search
  • skills
  • execute_code and delegate_task
  • vision
It intentionally excludes things that do not fit typical editor UX, such as messaging delivery and cronjob management. The toolset resolves the same way as on the messaging gateway for the same platform config. That includes the extras the gateway adds on top of the list, such as enabled plugin toolsets, so ACP sessions get those too. platform_toolsets.acp replaces the mibyan-acp default, and agent.disabled_toolsets removes toolsets from every ACP session. MCP servers from mcp_servers follow the same rules too. By default ACP gets every enabled server. If you list server names in platform_toolsets.acp, only those servers are included, and no_mcp drops them all. mibyan tools has no ACP entry, so edit config.yaml directly:
MCP servers that the editor sends with session/new are separate. The client asks for them per session, and they are always added.

Installation

Install Mibyan normally, then add the ACP extra from the install checkout:
This installs the agent-client-protocol dependency and enables:
  • mibyan acp
  • mibyan-acp
  • python -m acp_adapter

Launching the ACP server

Any of the following starts Mibyan in ACP mode:
Mibyan logs to stderr so stdout remains reserved for ACP JSON-RPC traffic. For non-interactive checks:

Browser tools (optional)

Browser tools (browser_navigate, browser_click, etc.) depend on the agent-browser npm package and Chromium, which aren’t part of the Python wheel. Install them with:
This is the standalone command. The terminal-auth flow (mibyan acp --setup) also offers the browser bootstrap as a follow-up question after model selection, so most users never need to run --setup-browser directly. What it does:
  • Installs Node.js 26 into ~/.mibyan/node/ if missing
  • npm install -g agent-browser @askjo/camofox-browser into that prefix (no sudo needed — npm’s --prefix points at the user-writable Mibyan-managed Node)
  • Installs Playwright Chromium, or uses a detected system Chrome/Chromium when available
The bootstrap is idempotent — re-running it is fast and skips work that’s already done.

Host setup

Buzz channels (relay bridge)

Buzz is a Nostr-based collaboration platform for people and agents. Its buzz-acp harness connects Buzz channels to any ACP agent over stdio:
This is a transport integration, not a second Mibyan installation. The subprocess launched by buzz-acp uses the same Mibyan configuration, credentials, memory, skills, and state as mibyan on that host. (This is distinct from Buzz Desktop’s managed runtime, which spawns Mibyan locally as a preset harness. The relay bridge is for joining Buzz channels as an agent identity, typically on a server.) Prerequisites:
  • Complete the ACP installation and mibyan acp --check above.
  • Build buzz-acp and the buzz CLI from the Buzz repository (cargo build --release -p buzz-acp).
  • Mint a dedicated Nostr keypair for Mibyan (buzz-admin generate-key) and register it as a relay member (buzz-admin add-member). Every agent needs its own identity — do not reuse a human keypair.
  • Add that identity to the intended Buzz channels.
Start a bridge with:
BUZZ_API_TOKEN is needed only when the relay enforces token authentication. Do not commit or paste the private key or API token. For a persistent server deployment, run buzz-acp under a service manager as the same operating-system user that owns the intended Mibyan home. Setup, key generation, channel discovery, and per-agent options are documented in the buzz-acp README. The bridge discovers every Buzz channel where the Mibyan identity is a member and automatically subscribes when it is added to another channel. Buzz channel membership therefore remains the access boundary; Mibyan does not need a separate channel list in its own configuration. To expose Mibyan ACP activity in the owner’s Buzz Desktop, add:
This publishes encrypted kind 24200 observer frames addressed to the agent’s owner (Buzz’s NIP-AO). Desktop renders the live lifecycle, tool, response, and usage stream in the agent’s Activity log. The relay treats these frames as ephemeral, so Desktop must be online before the turn starts; its local observer archive is the durable owner-side history. Headless bridges answer ACP permission requests themselves because no editor is present to show approval dialogs — see Keep Buzz agents owner-only. Treat the bridge as privileged automation: use a dedicated operating-system account, restrict which Buzz users can prompt the agent (buzz-acp supports an owner-only respond gate via BUZZ_ACP_AGENT_OWNER), and grant membership only in channels where Mibyan is expected to work.

VS Code

Install the ACP Client extension. To connect:
  1. Open the ACP Client panel from the Activity Bar.
  2. Select Mibyan from the built-in agent list.
  3. Connect and start chatting.
If you want to define Mibyan manually, add it through VS Code settings under acp.agents:

Zed

Configure Mibyan as a custom agent server in Zed settings:
  1. Open the Agent Panel.
  2. Add a custom agent server with the following configuration:
  1. Start a new Mibyan external-agent thread.
Prerequisites:
  • Configure Mibyan provider credentials first with mibyan model, or set them in ~/.mibyan/.env / ~/.mibyan/config.yaml.

JetBrains

Use an ACP-compatible plugin and point it at mibyan acp or mibyan-acp.

Buzz Desktop

Buzz ships Mibyan as a preset runtime. With Mibyan installed the normal way, Buzz discovers it automatically — open Settings → Runtimes and Mibyan appears under your runtimes. If discovery fails (older installs), make sure the ACP launcher resolves on a login-shell PATH:
Recent installs write both mibyan and mibyan-acp launchers into ~/.local/bin; running mibyan update adds the mibyan-acp launcher to older installs. As a manual fallback, configure Buzz’s agent command as mibyan with args ["acp"].

Model picker

Buzz Desktop (v0.5.1+) renders Mibyan’ full model menu in the agent’s runtime settings. The list comes from Mibyan itself over ACP: it shows every model from providers you have authenticated in Mibyan (the same inventory behind mibyan model and the /model command), so a model missing from the menu means its provider has no credentials configured on the Mibyan side. Entry IDs take the form provider:model (e.g. openrouter:z-ai/glm-5.1), or custom:<name>:<model> for custom OpenAI-compatible endpoints defined in config.yaml. Picking a model applies to that agent’s session; it does not change your Mibyan-wide default — use mibyan model for that.

Keep Buzz agents owner-only

Buzz creates every agent with Who can talk to this agent set to Owner only. Leave it there when the runtime is Mibyan. Two behaviors combine on this path. The mibyan-acp toolset includes terminal and execute_code, and Buzz’s ACP bridge answers Mibyan’ permission requests itself with allow_once rather than surfacing them. A Mibyan agent in Buzz therefore runs shell commands on the host without prompting. I asked one to run rm -rf against a scratch directory and it deleted it, no prompt anywhere. Selecting Anyone hands that same shell access to every author who can reach the channel. Buzz does not warn when you pick it. approvals.mode: manual does not help: Mibyan raises the permission request, but Buzz auto-approves it and the command still runs. To take the shell away, narrow the toolset instead: set platform_toolsets.acp to a list without terminal and code_execution, or add them to agent.disabled_toolsets. Even an empty platform_toolsets.acp: [] still adds enabled plugin toolsets, so name any plugin toolset you want gone in agent.disabled_toolsets. !shutdown from the owner stops the agent in any mode, and Buzz ignores that command from everyone else.

Configuration and credentials

ACP mode uses the same Mibyan configuration as the CLI:
  • ~/.mibyan/.env
  • ~/.mibyan/config.yaml
  • ~/.mibyan/skills/
  • ~/.mibyan/state.db
Provider resolution uses Mibyan’ normal runtime resolver, so ACP inherits the currently configured provider and credentials. Mibyan also advertises a terminal auth method (--setup) for first-run ACP clients; this opens Mibyan’ interactive model/provider setup.

Host integration

These variables are set by an ACP host process (an editor or another agent harness) on the Mibyan subprocess it spawns. They are not user configuration — do not set them by hand in .env or config.yaml. Mibyan normally starts every MCP server configured in config.yaml before it enters the ACP JSON-RPC loop. A host that owns MCP itself — passing the session’s servers explicitly through session/new — does not need that global startup, and an unrelated slow or interactive MCP server would otherwise delay initialize. Setting the marker to exactly 1 lets such a host skip it. Only the global config.yaml discovery is skipped. MCP servers supplied by the ACP session through session/new are still registered, so a host loses no capability it asked for. Any other value (unset, empty, 0, false) keeps the default behavior, so an unrelated truthy-looking string cannot silently disable MCP.

Session behavior

ACP sessions are tracked by the ACP adapter’s in-memory session manager while the server is running. Each session stores:
  • session ID
  • working directory
  • selected model
  • current conversation history
  • cancel event
Conversations are persisted to Mibyan’ session database and can be listed, loaded, resumed, or forked after the ACP server restarts. Opening a new session without a prompt keeps it in memory only: model-discovery probes do not create empty history rows. A nonempty fork is persisted immediately, and existing session metadata can still be updated even when its current history is empty. Existing empty rows from older versions are not automatically deleted. An open ACP row does not prove its client has disconnected. After closing the relevant editor sessions, inspect unwanted rows with mibyan sessions show <id> and remove only confirmed unwanted sessions with mibyan sessions delete <id>.

Working directory behavior

ACP sessions bind the editor’s cwd to the Mibyan task ID so file and terminal tools run relative to the editor workspace, not the server process cwd.

Approvals

Dangerous terminal commands can be routed back to the editor as approval prompts. ACP approval options are simpler than the CLI flow:
  • allow once
  • allow always
  • deny
Whether you actually see a prompt is up to the host. A host is free to answer the request programmatically instead of showing it to you, in which case these options exist on the wire but never reach a human. Buzz Desktop does this, so treat that path as unattended execution regardless of your approvals setting. On timeout or error, the approval bridge denies the request. The wait is approvals.timeout from config.yaml (default 300 s), the same knob the CLI and gateway prompts use — raise it if your editor keeps approval cards open longer.

Session-scoped edit auto-approval

ACP exposes a third tier between allow once and allow always: Allow for session. Picking it from the editor’s permission prompt records the approval inside the current ACP session only — every subsequent matching command in that session goes through without prompting, but a new ACP session (or restarting the editor) resets the slate and re-prompts the first time. allow_session is the right default for an editor workflow where you trust an agent for the duration of a task but don’t want to grant a long-lived allowlist entry. The safety trade-off is straightforward: the broader the scope, the less the editor will interrupt you, and the more damage a misbehaving agent (or prompt injection) can do before you notice. Start with allow_once for unfamiliar commands; promote to allow_session once you’ve seen the agent run the same pattern correctly a few times; reserve allow_always for truly idempotent commands you trust forever (e.g. git status). The ACP bridge maps these options onto Mibyan’ internal approval semantics — allow_always writes a permanent allowlist entry the same way the CLI does, while allow_session only affects the in-process approval cache for the current ACP session.

Troubleshooting

ACP agent does not appear in the editor

Check:
  • For manual/local development, verify the host command points to mibyan acp.
  • Mibyan is installed and on your PATH.
  • The ACP extra is installed (cd ~/.mibyan/mibyan-agent && python -c "import pm; pm.sync_venv(['acp'], explicit=True)").

ACP starts but immediately errors

Try these checks:

Missing credentials

ACP mode uses Mibyan’ existing provider setup. Configure credentials with:
or by editing ~/.mibyan/.env. The terminal auth flow (mibyan acp --setup) can also trigger the interactive provider/model setup.

See also