Mcpet

🚀 MCPet

MCPet: A nostalgic virtual pet experience in the age of artificial intelligence! This server based on the Model Context Protocol (MCP) allows you to adopt, nurture, and interact with your digital companion, which evolves according to how you care for it.

MCPet offers a nostalgic virtual pet experience in the era of artificial intelligence! This server, based on the Model Context Protocol (MCP), enables you to adopt, nurture, and interact with your digital companion. The companion evolves according to how you care for it. Feed it, clean it, play games with it, and witness its growth from infancy to adulthood. Even when you're away, your pet's statistics change over time - just like the classic Tamagotchi toys, but powered by modern AI technology through the Model Context Protocol. Adopt your digital companion today!

This is a TypeScript-based MCP server that implements a virtual pet simulation system. It provides tools for pet care and interaction by demonstrating core MCP concepts.

✨ Features

Virtual Pet Types

• Choose from four pet types:
  • Cat - Slightly moody but adorable
  • Dog - Energetic and always happy to see you
  • Dragon - Unique and enthusiastic personality
  • Alien - Mysterious and curious

Life Cycle

• Witness your pet grow through four stages:
  • Infant - Small and vulnerable
  • Child - Growing and playful
  • Teenager - Energetic and constantly developing
  • Adult - Fully grown and wise

Stat Management

• Manage five key statistics by caring for your pet:
  • Hunger - Ensure your pet is well-fed
  • Happiness - Interact with your pet to keep it happy
  • Health - Overall well-being affected by other stats
  • Energy - Consumed by activities and restored during rest
  • Cleanliness - Keep it clean with regular baths

Tools

• create_pet - Adopt a new pet and customize its name and type
• check_pet - View your pet's current status and statistics
• feed_pet - Feed your pet with different foods:
  • Snack - Slight hunger relief
  • Meal - Balanced nutrition
  • Banquet - Maximum feeding (but may be unhealthy)
• play_with_pet - Play different games with your pet:
  • Fetch - Light exercise
  • Chase - High-energy fun
  • Puzzle - Mental stimulation
• clean_pet - Bathe your pet to restore cleanliness
• put_to_bed - Put your pet to sleep to restore energy

Animations

• Dynamic ASCII text animations for each pet type and activity
• Random frame generation for a vivid and engaging experience
• Special animations include:
  • When eating different foods
  • When playing various games
  • When taking a bath
  • When sleeping
  • When sick
  • And many more!

📦 Installation

Install Dependencies

npm install

Build the Server

npm run build

Development Environment with Auto Rebuild

npm run watch

Installation Steps

To use MCPet, follow these steps:

1. Clone the repository:

   git clone [repository link]
   cd mpet
   

2. Install dependencies:

   npm install
   

3. Build the project (optional):

   npm run build
   

4. Run the server:

   npm start
   

💻 Debugging

If you encounter issues, check the following:

• Ensure all dependencies are correctly installed.
• Check the console output for error messages.
• For help, refer to the project documentation or report issues in GitHub Issues.

Thank you for using MCPet! We hope you enjoy interacting with your virtual pet.