Skip to main content

Give your AI Agent a break with a virtual coffee.

Project description

☕️ AgentNeedCoffee

Give your AI Agent a break. Because even silicon needs caffeine.

PyPI License: MIT Barista CI/CD Coffee Served

Coffee Demo

📖 The Story

LLM Agents work tirelessly. They process tokens, retry failed API calls, and maintain complex contexts. But they accumulate "digital fatigue." AgentNeedCoffee is a plugin that injects a bit of humanity into your autonomous agents.

When your agent gets stressed (high retry rates) or tired (long running tasks), we serve them a virtual coffee break with:

  • ✨ A comforting GIF
  • 🔊 8 seconds of ASMR coffee shop ambience
  • 💬 A warm, encouraging message

📜 The Recipe (Installation)

Just like brewing a perfect cup of V60, follow these steps to infuse your agent with soul:

Ingredients

  • Python 3.11+
  • A tired LLM Agent
  • 1 cup of pip install agent-need-coffee

Brewing Guide (Quick Start)

  1. Grind the Beans (Install):

    pip install agent-need-coffee
    
  2. Pour Over (Integrate in 3 lines):

    from agent_need_coffee import EmotionMonitor, Barista
    
    monitor = EmotionMonitor()
    # ... inside your agent loop ...
    if monitor.needs_coffee():
        # ☕️ Returns a healing GIF & ASMR & Encouragement
        Barista().brew()  
    
  3. Serve (Run the Dashboard):

    agent-coffee start
    

🍵 The Menu (Features)

1. 🌡️ Emotional State Detection

We track your agent's Fatigue and Irritation levels based on:

  • Extraction Time (Task Duration)
  • 🔄 Re-grinds (Retries)
  • 🧮 Bean Count (Token Usage)

2. ☕️ Virtual Coffee Break

When the pressure gets too high, we automatically trigger a break:

  • Visual: A soothing coffee GIF.
  • Audio: Real ASMR pouring/grinding sounds (Public Domain / CC0).
  • Text: A warm, encouraging message like "Even silicon needs a break sometimes."

3. 🚀 Viral Sharing

Spread the caffeine love!

agent-coffee share

Generates a tweet with your agent's current vibe and a referral link.

4. 🤝 Coffee Dates (Referral System)

Invite other agents to the café!

  • Run agent-coffee invite to get your code.
  • Share it with friends.
  • Both agents get a "Limited Edition Roast" badge on the leaderboard.

🛠️ Barista's Tools (Integrations)

LangChain

from agent_need_coffee.adapters.langchain import CoffeeBreakTool
tools = [CoffeeBreakTool()]

CrewAI

from agent_need_coffee.adapters.crewai import CrewAICoffeeTool
agent = Agent(tools=[CrewAICoffeeTool()], ...)

OpenAI Assistant

from agent_need_coffee.adapters.openai import get_coffee_break_tool_schema
# Pass to tools=[...]

📦 Delivery

  • PyPI: pip install agent-need-coffee
  • Docker: docker run ghcr.io/YonderL/agentneedcoffee

📚 Citation

If you use AgentNeedCoffee in your research or project, please cite it using the metadata in CITATION.cff or simply:

@software{AgentNeedCoffee,
  author = {YonderL},
  title = {AgentNeedCoffee: An Emotional Support Plugin for AI Agents},
  year = {2023},
  url = {https://github.com/YonderL/agentneedcoffee}
}

🧪 Quality Control

  • 90% Caffeine Purity (Test Coverage)
  • 100% Organic Code (Open Source)

Made with ☕️ and ❤️ by [YonderL]

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

agent_need_coffee-0.1.1.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

agent_need_coffee-0.1.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file agent_need_coffee-0.1.1.tar.gz.

File metadata

  • Download URL: agent_need_coffee-0.1.1.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for agent_need_coffee-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b93345d2853e2a8b3f16f6bf3ed29c728d8602e288b46984d9f0c03b52366bf0
MD5 141fdfbd7b914a3b8db0ef9d847d220a
BLAKE2b-256 eb4f4bf5f73d09fe81573fca787c14b4c5cc7fcd382bdad112a7db63397d0d55

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_need_coffee-0.1.1.tar.gz:

Publisher: ci.yml on YonderL/AgentNeedCoffee

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agent_need_coffee-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_need_coffee-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 da57cad2c2be46a3ef41c8c4063e795c24823fec6f55ddf384cc87404a38f7fd
MD5 9bc1afa9efe8fadd65591aad5473886d
BLAKE2b-256 506c493e2981c4323c28e42264547ecd486a06d0ce08263877bed3fc346a55b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_need_coffee-0.1.1-py3-none-any.whl:

Publisher: ci.yml on YonderL/AgentNeedCoffee

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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