MCPet

This is a TypeScript-based Model Context Protocol (MCP) server that implements a virtual pet simulation system. It demonstrates core MCP concepts by providing tools for pet care and interaction.

typescript

10

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "shreyaskarnik-mcpet": {
      "command": "node",
      "args": [
        "/path/to/mcpet/build/index.js"
      ],
      "env": {
        "PET_DATA_DIR": "<path-to-writable-directory>"
      }
    }
  }
}

MCPet is a TypeScript-based MCP server that lets you adopt, nurture, and play with a digital pet that evolves based on how you care for it. You interact with your pet through a simple set of commands, watch it grow through distinct life stages, and see its stats change over time. This guide shows you how to use MCPet with an MCP client, install and run the server locally, and configure it for desktop integration.

How to use

Interact with your MCPet using practical actions that affect its growth and happiness. Create a pet, check its status, feed it with different foods, play games to boost energy and happiness, clean it to maintain cleanliness, and put it to bed to restore energy. The server responds with evolving ASCII animations that visualize your pet’s activities and mood.

Typical usage patterns include adopting a pet with a chosen name and type, then regularly checking its status to adjust feeding and play. You can simulate daily care even when you’re away, as the pet’s stats evolve over time.

How to install

Prerequisites you need before running MCPet: Node.js and npm (Node.js 14+ recommended). Ensure you have a writable directory for storing pet data.

Install dependencies and build the server locally.

npm install
npm run build

For development with automatic rebuild on changes use:

npm run watch

Configure MCPet for Claude Desktop via Smithery

To run MCPet alongside Claude Desktop, configure a local MCP server using the stdio interface. The server is started with node and the built entry point, and you must provide a writable data directory.

{
  "mcpServers": {
    "mcpet": {
      "command": "node",
      "args": ["/path/to/mcpet/build/index.js"],
      "env": {
        "PET_DATA_DIR": "/path/to/writable/directory"
      }
    }
  }
}

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. Use the MCP Inspector to test pet interactions directly.

npx @modelcontextprotocol/inspector node /path/to/mcpet/build/index.js

Usage examples

Ask Claude or your MCP client to perform actions such as creating a pet named Whiskers, checking status, feeding a meal, playing a game like Chase, giving a bath, or putting the pet to bed.

Available tools

create_pet

Adopt a new pet by specifying a name and type.

check_pet

View the current status and stats of your pet.

feed_pet

Feed your pet with different options: Snack, Meal, Feast.

play_with_pet

Play different games: Ball, Chase, Puzzle.

clean_pet

Baths to restore cleanliness.

put_to_bed

Let your pet sleep to restore energy.