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.
🚀 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
- PyPI: https://pypi.org/project/goose-mentor-mode/
- Latest Version:
🛠️ 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
- Open Goose Desktop
- Go to Settings → Profiles
- Select your profile or create a new one
- Add
mentorto the Toolkits list - 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:
- Go to Settings → Profiles → [Your Profile]
- Add environment variables in the Environment section
- 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
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Add tests for new functionality
- Run tests (
uv run pytest) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - 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
- Issues: GitHub Issues
- Documentation: GitHub Wiki
- Discussions: GitHub Discussions
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file goose_mentor_mode-0.1.2.tar.gz.
File metadata
- Download URL: goose_mentor_mode-0.1.2.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
56a7b589b9e01732b58a24d6af8a9d6e630b127101ba376ecbc8473fdab476de
|
|
| MD5 |
c0c5d3382a420090b4a096b196edf13f
|
|
| BLAKE2b-256 |
a423a4e58525f68869416227c119935da6d78a54ec2754e1153286a3d47044a2
|
File details
Details for the file goose_mentor_mode-0.1.2-py3-none-any.whl.
File metadata
- Download URL: goose_mentor_mode-0.1.2-py3-none-any.whl
- Upload date:
- Size: 14.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4ecff55dc97e86c3a54a092839ecd11c06a7bc162c36f549f90609b3dc2b5c8
|
|
| MD5 |
350d0d71888e29eb07b5fe01c346852c
|
|
| BLAKE2b-256 |
395fa30e58bb5208cab3b3c98ed536ab910f9e392dbf3972b904033da3933cb3
|