Skip to main content

AI-powered mentor extension for Goose that transforms automation into guided learning

Project description

Goose Mentor Mode 🎓

AI-powered mentor extension for Goose that transforms development assistance from automation into guided learning experiences.

PyPI version Python 3.11+ License: MIT

🚀 Features

  • Adaptive Learning Assistance: Four assistance levels (GUIDED, EXPLAINED, ASSISTED, AUTOMATED)
  • Socratic Questioning: Helps users discover solutions through guided questions
  • Learning Opportunity Detection: Automatically identifies educational moments
  • Progress Tracking: Monitors learning progress and provides recommendations
  • Environment Configuration: Easy setup through environment variables
  • Goose Integration: Seamless integration with Goose AI assistant

🎉 Now Available on PyPI!

Goose Mentor Mode is officially published and available to the entire Python community! Install it with a single command and start transforming your AI assistance from automation to education.

📦 Installation

Goose Mentor Mode is a Goose extension that integrates seamlessly with Goose Desktop. There are two installation methods:

🚀 Quick Install via PyPI (Recommended)

# Install the package
pip install goose-mentor-mode

# Or with uv
uv add goose-mentor-mode

📦 PyPI Package

🛠️ Development Installation

# Clone and install for development
git clone https://github.com/joeeuston-dev/goose-mentor-mode.git
cd goose-mentor-mode
uv sync

# Or with pip in development mode
pip install -e .

⚙️ Configuration

Goose Desktop Integration

After installing the package, configure it in Goose Desktop:

Step 1: Install the Package

pip install goose-mentor-mode

Step 2: Configure in Goose Desktop

Method 1: Through Goose Desktop UI

  1. Open Goose Desktop
  2. Go to SettingsProfiles
  3. Select your profile or create a new one
  4. Add mentor to the Toolkits list
  5. Optionally configure environment variables for customization

Method 2: Direct Profile Configuration

Add to your Goose profile configuration:

toolkits:
  - name: mentor
    package: goose-mentor-mode

Step 3: Environment Configuration (Optional)

Customize behavior using environment variables:

# Core Configuration
DEFAULT_ASSISTANCE_LEVEL=guided          # guided|explained|assisted|automated
LEARNING_PHASE=skill_building           # onboarding|skill_building|production
TIMELINE_PRESSURE=low                   # low|medium|high
ENABLE_VALIDATION_CHECKPOINTS=true     # Enable learning validation
MAX_GUIDANCE_DEPTH=3                    # Depth of Socratic questioning
DEVELOPER_EXPERIENCE_MONTHS=6           # Developer experience level

Environment Variable Configuration in Goose Desktop:

  1. Go to Settings → Profiles → [Your Profile]
  2. Add environment variables in the Environment section
  3. Save and restart Goose Desktop

📖 For detailed usage examples and scenarios, see USAGE_EXAMPLES.md

🎯 For complete Goose Desktop setup instructions, see GOOSE_DESKTOP_CONFIG.md

🎯 Assistance Levels

🧭 GUIDED Mode

  • Purpose: Learning through discovery
  • Approach: Socratic questioning and guided exploration
  • Best For: New concepts, skill building, deep understanding
  • Example: "What do you think JWT stands for? How might stateless authentication work?"

📚 EXPLAINED Mode

  • Purpose: Education with solutions
  • Approach: Detailed explanations with implementation
  • Best For: Time-sensitive tasks with learning value
  • Example: "Here's how JWT works... [detailed explanation] + working code"

🤝 ASSISTED Mode

  • Purpose: Quick help with learning opportunities
  • Approach: Direct help with educational context
  • Best For: Experienced developers needing quick assistance
  • Example: "Use this JWT library. Key security considerations: [brief points]"

⚡ AUTOMATED Mode

  • Purpose: Direct task completion
  • Approach: Efficient solutions without educational overhead
  • Best For: Production pressure, repeated tasks
  • Example: "Here's the complete JWT implementation."

🛠️ Tools

mentor_analyze_request

Analyzes user requests for learning opportunities and recommends assistance levels.

toolkit.mentor_analyze_request(
    user_request="How do I implement JWT authentication?",
    context={"experience_months": 6, "timeline_pressure": "low"}
)

mentor_learning_check

Validates understanding through Socratic questioning.

toolkit.mentor_learning_check(
    concept="JWT Authentication",
    user_explanation="JWT is a token that contains user information",
    expected_understanding=["stateless", "secure", "token-based"]
)

mentor_track_progress

Tracks learning progress and provides recommendations.

toolkit.mentor_track_progress(
    activity="Implementing JWT authentication",
    success_indicators={"task_completed": True, "time_spent": 30}
)

mentor_suggest_assistance_level

Suggests optimal assistance level for given context.

toolkit.mentor_suggest_assistance_level(
    user_request="I need help with AWS Lambda",
    context={"experience_months": 6, "timeline_pressure": "medium"}
)

🎓 Educational Philosophy

Mentor Mode transforms AI assistance from automation to education:

  • Discovery Over Delivery: Help users understand why, not just how
  • Adaptive Learning: Adjusts approach based on experience and context
  • Progressive Complexity: Builds understanding layer by layer
  • Retention Focus: Emphasizes learning that sticks

🔧 Developer Profiles

New Developer (0-6 months)

DEFAULT_ASSISTANCE_LEVEL=guided
LEARNING_PHASE=onboarding
TIMELINE_PRESSURE=low
ENABLE_VALIDATION_CHECKPOINTS=true

Developing Skills (6-24 months)

DEFAULT_ASSISTANCE_LEVEL=explained
LEARNING_PHASE=skill_building
TIMELINE_PRESSURE=medium
ENABLE_VALIDATION_CHECKPOINTS=true

Experienced Developer (24+ months)

DEFAULT_ASSISTANCE_LEVEL=assisted
LEARNING_PHASE=production
TIMELINE_PRESSURE=medium
ENABLE_VALIDATION_CHECKPOINTS=false

🧪 Testing

# Run all tests
uv run pytest

# Run with coverage
uv run pytest --cov=goose_mentor_mode

# Run specific test
uv run pytest tests/test_mentor_toolkit.py::TestMentorToolkit::test_mentor_analyze_request

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add tests for new functionality
  5. Run tests (uv run pytest)
  6. Commit your changes (git commit -m 'Add amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Built for the Goose AI Assistant
  • Inspired by Socratic teaching methods
  • Designed for developers who value learning

📞 Support


Transform your AI assistance from automation to education with Goose Mentor Mode! 🎓✨

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

goose_mentor_mode-0.1.3.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

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

goose_mentor_mode-0.1.3-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file goose_mentor_mode-0.1.3.tar.gz.

File metadata

  • Download URL: goose_mentor_mode-0.1.3.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for goose_mentor_mode-0.1.3.tar.gz
Algorithm Hash digest
SHA256 96980b281c33ecdd4fe329eca3fa51765d79fcb71a1bc955e7eaa6be1c70e979
MD5 bcff3087299603adf2da089129ce678a
BLAKE2b-256 b2d1a371f42c1ecc75fef7e48c07b4f13bd55c27a60d58cff9e9b1803d0af7cb

See more details on using hashes here.

File details

Details for the file goose_mentor_mode-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for goose_mentor_mode-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1a28695e46c62681ca434c4ad69b918ff755a760eff7eb3e47e5304022dbf197
MD5 0780262a01955625575597dba642ccc5
BLAKE2b-256 6ae941e6cd1a64a18fcec5039673916e36eca6b766c29ff3f24f01a24fcbed6b

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