# OpenPet > Electron desktop pet platform with AI chat, pet packs, plugins, and local agent APIs. - **Type:** MCP server - **Install:** `agentstack add mcp-dengyie-openpet` - **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior - **Seller:** [dengyie](https://agentstack.voostack.com/s/dengyie) - **Installs:** 0 - **Category:** [AI & ML](https://agentstack.voostack.com/c/ai-and-ml) - **Latest version:** 0.1.0 - **License:** MIT - **Upstream author:** [dengyie](https://github.com/dengyie) - **Source:** https://github.com/dengyie/OpenPet ## Install ```sh agentstack add mcp-dengyie-openpet ``` Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent. ## About # OpenPet An Electron desktop pet platform with a visual Control Center, AI chat, plugins, pet packs, and local agent APIs. [](./tests) [](./package.json) [](./LICENSE) [](./package.json) [English](./README.md) | [简体中文](./README.zh-CN.md) OpenPet puts a small animated pet on your desktop and gives it a real platform behind the scenes. The pet can walk, speak, play actions, switch character packs, react to AI replies, and grow through a developer-first local extension ecosystem. The project is currently a release-candidate desktop platform rather than a toy demo: it has a real Electron service layer, a React Control Center, bundled pet packs, OpenAI-compatible AI settings, local extension runtime controls, loopback-only automation APIs, and release evidence tooling. The current release track is macOS-first. Windows build and validation tooling exists, but Windows is not advertised as release-ready until signed installer evidence and real smoke reports are archived. ## What You Get - Transparent desktop pet window with drag, walking, actions, and speech bubbles. - React + Vite Control Center for Pet, Actions, AI, Plugins, Catalog, Service, and About settings, including compact narrow-window layouts. - Pet pack runtime with legacy cat support, folder import, `.codex-pet.zip` import, and native `pet.json` + `spritesheet.webp` Codex pet atlases. - Three bundled built-in pets: `doro`, `duodong`, and `chispa`. - OpenAI-compatible chat and image-provider configuration with API keys kept in the main process secret store. - Creator Studio workflows for prompt planning, image-backed atlas generation, frame repair, approval, dashboard review, and pet/action import. - Developer-first local extension model with current legacy SDK compatibility, explicit command/dashboard/service controls, creator-tools action, pack-manifest, package-local asset, user-approved picker asset bridges, cleanup evidence tooling, validation, logs, catalog install, and uninstall flow. - Optional loopback-only HTTP and MCP endpoints for local tools and agents. - Gradual TypeScript migration baseline covering shared contracts and the Control Center API facade. ## Quick Start Requirements: - Node.js 18 or newer - npm 9 or newer - macOS for the currently validated packaged app path ```bash git clone https://github.com/dengyie/OpenPet.git cd OpenPet npm install npm start ``` Useful commands: ```bash npm start # Build Control Center and launch Electron npm run dev:control-center # Control Center hot reload at http://127.0.0.1:5173 npm run test:core # Core Node runtime regression suite npm run test:core:all # Core Node suite + Control Center Playwright suite npm run test:tools # Release/tooling Node tests npm test # Full Node test suite npm run test:control-center # Playwright UI regression suite npm run typecheck # TypeScript no-emit check npm run check:syntax # Node syntax + typecheck + Control Center build npm run pack # electron-builder directory package npm run dist # macOS DMG/ZIP on macOS ``` ## Project Shape OpenPet is split into a small pet renderer, an Electron main process, and an embedded Control Center. ```text main.js assembles services and Electron lifecycle src/main/services/ EventBus -> SettingsService -> ActionService -> PetService |-> AiService |-> PluginService |-> LocalHttpService / MCP src/main/services/plugin-*.js plugin discovery, JSON/storage/log/network helpers, and local runner boundary modules src/control-center/ React + Vite UI embedded in Electron src/main/pet-pack/ pet.json schema, loader, importer, Codex atlas adapter ``` Important project rules: - `PetService` is the single source of truth for pet state. - User-facing configuration belongs in Control Center, not manual JSON edits. - API keys never go to the renderer. - Third-party extensions are local software: OpenPet should show what they declare and manage lifecycle/logs/uninstall, without claiming a complete sandbox for arbitrary local processes. - The existing `cat_anime/` material structure is kept intact. ## Pet Packs OpenPet supports: - Built-in legacy cat assets from `cat_anime/`. - User-imported action frame folders. - OpenPet pet packs with `pet.json`. - Codex-compatible pet directories containing `pet.json` and `spritesheet.webp`. - Codex pet zip packages. - Built-in read-only packs under `assets/pet-packs/`. To add a new action manually, put ordered transparent frames under `cat_anime/flames//` and run: ```bash npm run generate-sprites ``` For normal use, import pet packs from Control Center -> Actions -> Pet Packs. ## Extension Development OpenPet uses one third-party package model: an extension. The package manifest is still named `plugin.json` for compatibility. The host now normalizes and inspects extension declarations for `entries.setup`, `entries.commands`, `entries.services`, `entries.dashboards`, `manifest`, `config`, and `assets`; JavaScript compatibility packages can expose `entries.commands` through the existing runner, and declaration-only local extensions can run short-lived `entries.commands` as explicit user actions with JSON stdin context and a short-lived bridge for `pet.say`, `pet.action`, `pet.event`, bounded context reads, creator-tools action reads/writes, active installed pack manifest metadata workflows, package-local frame inspection/import, and user-approved picker frame inspection/import. Enabled plugins can explicitly run declared setup entries, open declared HTTP/HTTPS dashboards, start or stop declared service entries, manually check declared loopback service health endpoints, and enable host-managed periodic checks for already-running services from Control Center. Command, setup, and service processes are spawned without shell expansion, services do not auto-start, and setup and commands do not run during install or enable. Arbitrary shell consoles, arbitrary file writes, raw filesystem grants, general pet-pack writes, and hard process-tree guarantees remain future runtime work. Current legacy SDK examples are still useful while the host runtime catches up: - [Focus Timer](./examples/plugins/focus-timer/) for storage and pet speech. - [Weather Status](./examples/plugins/weather-status/) for legacy network allowlists. - [RSS Reader](./examples/plugins/rss-reader/) for public feed fetching and cached announcements. Target extension shape: ```text my-extension/ plugin.json config.schema.json # optional commands/ service/ web/ assets/ ``` Current validation and submission tooling still uses the historical "plugin" command name: ```bash npm run validate:plugin -- npm run create-plugin-submission-bundle -- --output-dir plugin-submission-bundle npm run validate-plugin-submission-bundle -- plugin-submission-bundle --require-ready ``` Read [plugin-development.md](./docs/plugin-development.md) and [plugin-submission-workflow-playbook.md](./docs/plugin-submission-workflow-playbook.md) for the full path. Extension authors should also read [plugin-ecosystem-rules.md](./docs/plugin-ecosystem-rules.md) for lifecycle, transparency, compatibility, and honest safety boundaries. ## Documentation - [CHANGELOG.md](./CHANGELOG.md) - release notes. - [docs/README.md](./docs/README.md) - documentation map and reading order. - [docs/TODO.md](./docs/TODO.md) - single active maintainer work queue. - [docs/HANDOFF.md](./docs/HANDOFF.md) - current maintainer snapshot, guardrails, and priorities. - [docs/plugin-ecosystem-rules.md](./docs/plugin-ecosystem-rules.md) - extension ecosystem boundary, lifecycle rules, and third-party author guidance. - [docs/project-context.json](./docs/project-context.json) - compact machine-readable project context. Use `docs/README.md` instead of browsing every file under `docs/`; historical phase, roadmap, and review records are retained as audit history, while active planning now lives in `docs/TODO.md`. ## Validation Baseline Current release-candidate baseline: ```bash npm run check:syntax # Node syntax + typecheck + Control Center build npm run test:core # core Node runtime regression suite npm run test:tools # release, evidence, scaffold, and maintenance tooling tests npm test # full Node native test suite npm run test:control-center # Playwright UI regression baseline npm run typecheck # TypeScript no-emit checks ``` ## License MIT. See [LICENSE](./LICENSE). ## Source & license This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code. - **Author:** [dengyie](https://github.com/dengyie) - **Source:** [dengyie/OpenPet](https://github.com/dengyie/OpenPet) - **License:** MIT Install and usage instructions live in the source repository linked above. ## Pricing - **Free** — Free ## Security capabilities Automated source analysis of v0.1.0 — what this tool can access: - **Network access:** no - **Filesystem access:** no - **Shell / process execution:** no - **Environment & secrets:** no - **Dynamic code execution:** no *"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.* ## Versions - **0.1.0** — security scan: passed — Imported from the upstream source. ## Links - Listing page: https://agentstack.voostack.com/l/mcp-dengyie-openpet - Seller: https://agentstack.voostack.com/s/dengyie - Browse the marketplace: https://agentstack.voostack.com/browse --- Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.