Skip to main content

MCP server for chibi — a local desktop pet that pops up a floating tk window (mood-tinted, live-updating, gacha-driven) in your Claude Code session

Project description

chibi-mcp (server)

MCP server for chibi — a local desktop character that visualizes Claude Code or Codex session state.

Code is MIT; bundled official artwork has separate terms (see OFFICIAL_ASSET_TERMS.md). chibi and chibi-mcp are unregistered trademarks of the project.

The server has two jobs running together in one process:

  1. MCP server (stdio) — Claude Code / Codex calls these tools to interact with chibi.
  2. WebSocket server (ws://127.0.0.1:9876) — pushes state snapshots and events to the desktop app.

Install from GitHub

pipx install "git+https://github.com/soccz/chibi-mcp.git#subdirectory=server"

Upgrade or refresh an existing install:

pipx uninstall chibi-mcp || true
pipx install "git+https://github.com/soccz/chibi-mcp.git#subdirectory=server"

(For local development from this repo, see "Develop" below.)

Register with Claude Code or Codex

claude mcp add chibi -- chibi-mcp
codex mcp add chibi -- chibi-mcp

Then call open_pet_window from the client — it launches the floating chibi window and connects to the local WebSocket.

CLI checks

chibi-mcp --check      # verify packaged assets + local runtime support
chibi-mcp --doctor     # verify local runtime + Claude/Codex/VS Code client state
chibi-mcp --open       # open the window and auto-start ws-only if needed
chibi-mcp --version
chibi-mcp --ws-only    # development: run only ws://127.0.0.1:9876
chibi-audit            # local trust report for team/security review
chibi-pack init ./my-pack
chibi-pack validate ./my-pack
chibi-pack preview ./my-pack
chibi-share --out share-card.png
chibi-share --preset social-preview --out social-preview.png
chibi-share --preset lineup --out starter-lineup.png
chibi-share --preset options --out option-showcase.png

In --doctor, ok: true means the local server/runtime is healthy, while ready: true means the checked Claude, Codex, and VS Code paths are also ready.

MCP tools

Tool Description
get_pet_state Returns mood, system metrics (CPU/RAM/battery), counters, timing. Counts as a Claude interaction (may trigger a milestone event every N calls).
pet_say(text) Make chibi say something in a speech bubble.
slice_now Force a milestone animation immediately.
set_slice_interval(n) Change how often (every N Claude tool calls) the milestone animation fires. Default: 10.
get_options List free visual option layers such as honey, beads, sprinkles, powder, sesame, petals, resin, and sauce.
set_active_options([ids]) / clear_active_options Apply or clear up to 3 free option layers.

WebSocket protocol (server → desktop)

JSON messages broadcast to all connected desktop clients:

{ "type": "state",
  "payload": {
    "mood": "calm | panting | drowsy | lonely | happy | surprised | joyful",
    "system": { "cpu_percent": 12.3, "ram_percent": 51.2, "battery_percent": 84.0, "battery_plugged": false },
    "counters": { "calls_total": 23, "calls_since_slice": 3, "slice_interval": 10, "slices_today": 2 },
    "timing": { "session_seconds": 1842, "idle_seconds": 7 }
  }
}

{ "type": "say", "text": "오늘도 같이 코딩!" }

{ "type": "slice" }

State is pushed every 2 seconds. say and milestone events are pushed on demand.

Environment variables

Var Default Purpose
CHIBI_WS_HOST 127.0.0.1 WebSocket bind host
CHIBI_WS_PORT 9876 WebSocket bind port
CHIBI_LOG_LEVEL INFO Logging level
CHIBI_EXPERIMENTAL_MACOS_PYOBJC_TRANSPARENCY ignored Legacy flag. PyObjC transparency is disabled; macOS always uses the stable Tk panel.

Develop

cd server
python3.12 -m venv venv
source venv/bin/activate
pip install -e ".[dev]"
pytest

Run directly (without an MCP client) for the WebSocket side only:

CHIBI_LOG_LEVEL=DEBUG python -m chibi_mcp

The stdio MCP side will wait for a client on stdin/stdout, so to test the WebSocket alone, connect a simple ws client to ws://localhost:9876 while the process runs.

Design notes

  • Counter resets only when the process restarts — intentional "today's-work" scope.
  • All metrics are local — no network calls, no telemetry, no accounts.
  • Milestone trigger is Claude-call-based (not wall-clock) — measures actual work, not just time sitting.

See ../SPEC.md and ../CHARACTER_DESIGN.md for the broader project context.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chibi_mcp-1.4.39.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chibi_mcp-1.4.39-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file chibi_mcp-1.4.39.tar.gz.

File metadata

  • Download URL: chibi_mcp-1.4.39.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for chibi_mcp-1.4.39.tar.gz
Algorithm Hash digest
SHA256 7d80a6bb48d0bd150bacbf173b0d0a9b2af7280c1649aa79583f0f0d1e96bf3f
MD5 a6711d8dc72ac732af379f9b6565bc0a
BLAKE2b-256 e03bde3738df48dc1ed89588f94b0fb21d4895794bf6b4f5615fe1b02a95c5a0

See more details on using hashes here.

File details

Details for the file chibi_mcp-1.4.39-py3-none-any.whl.

File metadata

  • Download URL: chibi_mcp-1.4.39-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for chibi_mcp-1.4.39-py3-none-any.whl
Algorithm Hash digest
SHA256 c9dfcf6f94dfe5dffd6d2875831669248227748a544914636ef08dc9f1b1ccc2
MD5 a6b59df489d533dbb3706fd64c6ba349
BLAKE2b-256 84c118c2ff2162c68bfa5e438681503436172229d8707f17481609212faf4403

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page