Name | goose-mentor-mode JSON |
Version |
0.1.6
JSON |
| download |
home_page | None |
Summary | AI-powered mentor extension for Goose that transforms automation into guided learning |
upload_time | 2025-08-08 10:49:40 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.11 |
license | MIT |
keywords |
ai
development
goose
learning
mcp
mentor
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Goose Mentor Mode ๐
AI-powered mentor extension for Goose that transforms development assistance from automation into guided learning experiences using the Model Context Protocol (MCP).
[](https://badge.fury.io/py/goose-mentor-mode)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/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
- **MCP Integration**: Modern Model Context Protocol extension for Goose Desktop
## ๐ 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 an MCP (Model Context Protocol) extension for Goose Desktop. It runs as a server that Goose communicates with to provide mentoring capabilities.
### ๐ Quick Install via Goose Desktop (Recommended)
**No manual installation required!** Goose Desktop will automatically install the package when you add it as an extension.
1. Open **Goose Desktop**
2. Click on **Extensions** menu
3. Select **Add Custom Extension**
4. Fill in the extension details:
- **Extension Name**: `Goose Mentor Mode`
- **Type**: `STDIO`
- **Description**: `Goose Mentor Mode makes your goose a Mentor that helps you learn as you work together!`
- **Command**: `uvx goose-mentor-mode`
5. Click **Add Extension**
6. The extension will be automatically installed and ready to use!
### ๐ฆ PyPI Package
- **PyPI**: https://pypi.org/project/goose-mentor-mode/
- **Latest Version**: [](https://badge.fury.io/py/goose-mentor-mode)
### ๐ ๏ธ Manual Installation (Development)
For development or manual setup:
```bash
# Clone and install for development
git clone https://github.com/joeeuston-dev/goose-mentor-mode.git
cd goose-mentor-mode
uv sync
# Build and test locally
uv build
uvx --from ./dist/goose_mentor_mode-*.whl goose-mentor-mode --help
```
## โ๏ธ Configuration
### Environment Variables (Optional)
Customize behavior using environment variables:
```bash
# 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](USAGE_EXAMPLES.md)**
๐ฏ **For complete Goose Desktop setup instructions, see [GOOSE_DESKTOP_CONFIG.md](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."
## ๐ ๏ธ MCP Tools
The extension provides four core MCP tools that work seamlessly with Goose:
### `mentor_analyze_request`
Analyzes user requests for learning opportunities and recommends assistance levels.
**Parameters:**
- `request`: The user's request or question
- `context`: Optional context about the current task or project
### `mentor_learning_check`
Validates understanding through Socratic questioning and provides learning feedback.
**Parameters:**
- `concept`: The concept or topic to validate understanding for
- `user_response`: User's response to previous questions (optional)
- `assistance_level`: Level of assistance (guided, explained, assisted, automated)
### `mentor_track_progress`
Tracks learning progress and provides recommendations for continued development.
**Parameters:**
- `topic`: The learning topic or subject area
- `interaction_data`: Data about the learning interaction
- `session_id`: Optional session identifier for progress tracking
### `mentor_suggest_assistance_level`
Suggests the optimal assistance level based on request complexity and user profile.
**Parameters:**
- `request`: The user's request or task
- `user_profile`: Optional user profile information
- `context`: Optional context about the current situation
> **Note**: These tools are automatically available in Goose once the extension is installed. Goose will intelligently use them based on your interactions to provide mentoring assistance.
## ๐ 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)
```bash
DEFAULT_ASSISTANCE_LEVEL=guided
LEARNING_PHASE=onboarding
TIMELINE_PRESSURE=low
ENABLE_VALIDATION_CHECKPOINTS=true
```
### Developing Skills (6-24 months)
```bash
DEFAULT_ASSISTANCE_LEVEL=explained
LEARNING_PHASE=skill_building
TIMELINE_PRESSURE=medium
ENABLE_VALIDATION_CHECKPOINTS=true
```
### Experienced Developer (24+ months)
```bash
DEFAULT_ASSISTANCE_LEVEL=assisted
LEARNING_PHASE=production
TIMELINE_PRESSURE=medium
ENABLE_VALIDATION_CHECKPOINTS=false
```
## ๐งช Testing
```bash
# 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](LICENSE) file for details.
## ๐ Acknowledgments
- Built for the [Goose AI Assistant](https://github.com/block/goose)
- Inspired by Socratic teaching methods
- Designed for developers who value learning
## ๐ Support
- **Issues**: [GitHub Issues](https://github.com/joeeuston-dev/goose-mentor-mode/issues)
- **Documentation**: [GitHub Wiki](https://github.com/joeeuston-dev/goose-mentor-mode/wiki)
- **Discussions**: [GitHub Discussions](https://github.com/joeeuston-dev/goose-mentor-mode/discussions)
---
**Transform your AI assistance from automation to education with Goose Mentor Mode! ๐โจ**
Raw data
{
"_id": null,
"home_page": null,
"name": "goose-mentor-mode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "ai, development, goose, learning, mcp, mentor",
"author": null,
"author_email": "Joe Euston <joe@example.com>",
"download_url": "https://files.pythonhosted.org/packages/32/1b/03e5dfa6ffefc0a1df49daa44069c8ea89103edfe777e3e52c252b5b9fcd/goose_mentor_mode-0.1.6.tar.gz",
"platform": null,
"description": "# Goose Mentor Mode \ud83c\udf93\n\nAI-powered mentor extension for Goose that transforms development assistance from automation into guided learning experiences using the Model Context Protocol (MCP).\n\n[](https://badge.fury.io/py/goose-mentor-mode)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n\n## \ud83d\ude80 Features\n\n- **Adaptive Learning Assistance**: Four assistance levels (GUIDED, EXPLAINED, ASSISTED, AUTOMATED)\n- **Socratic Questioning**: Helps users discover solutions through guided questions\n- **Learning Opportunity Detection**: Automatically identifies educational moments\n- **Progress Tracking**: Monitors learning progress and provides recommendations\n- **Environment Configuration**: Easy setup through environment variables\n- **MCP Integration**: Modern Model Context Protocol extension for Goose Desktop\n\n## \ud83c\udf89 Now Available on PyPI!\n\nGoose 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.\n\n## \ud83d\udce6 Installation\n\nGoose Mentor Mode is an MCP (Model Context Protocol) extension for Goose Desktop. It runs as a server that Goose communicates with to provide mentoring capabilities.\n\n### \ud83d\ude80 Quick Install via Goose Desktop (Recommended)\n\n**No manual installation required!** Goose Desktop will automatically install the package when you add it as an extension.\n\n1. Open **Goose Desktop**\n2. Click on **Extensions** menu\n3. Select **Add Custom Extension**\n4. Fill in the extension details:\n - **Extension Name**: `Goose Mentor Mode`\n - **Type**: `STDIO`\n - **Description**: `Goose Mentor Mode makes your goose a Mentor that helps you learn as you work together!`\n - **Command**: `uvx goose-mentor-mode`\n5. Click **Add Extension**\n6. The extension will be automatically installed and ready to use!\n\n### \ud83d\udce6 PyPI Package\n\n- **PyPI**: https://pypi.org/project/goose-mentor-mode/\n- **Latest Version**: [](https://badge.fury.io/py/goose-mentor-mode)\n\n### \ud83d\udee0\ufe0f Manual Installation (Development)\n\nFor development or manual setup:\n\n```bash\n# Clone and install for development\ngit clone https://github.com/joeeuston-dev/goose-mentor-mode.git\ncd goose-mentor-mode\nuv sync\n\n# Build and test locally\nuv build\nuvx --from ./dist/goose_mentor_mode-*.whl goose-mentor-mode --help\n```\n\n## \u2699\ufe0f Configuration\n\n### Environment Variables (Optional)\n\nCustomize behavior using environment variables:\n\n```bash\n# Core Configuration\nDEFAULT_ASSISTANCE_LEVEL=guided # guided|explained|assisted|automated\nLEARNING_PHASE=skill_building # onboarding|skill_building|production\nTIMELINE_PRESSURE=low # low|medium|high\nENABLE_VALIDATION_CHECKPOINTS=true # Enable learning validation\nMAX_GUIDANCE_DEPTH=3 # Depth of Socratic questioning\nDEVELOPER_EXPERIENCE_MONTHS=6 # Developer experience level\n```\n\n**Environment Variable Configuration in Goose Desktop:**\n1. Go to Settings \u2192 Profiles \u2192 [Your Profile]\n2. Add environment variables in the Environment section\n3. Save and restart Goose Desktop\n\n\ud83d\udcd6 **For detailed usage examples and scenarios, see [USAGE_EXAMPLES.md](USAGE_EXAMPLES.md)**\n\n\ud83c\udfaf **For complete Goose Desktop setup instructions, see [GOOSE_DESKTOP_CONFIG.md](GOOSE_DESKTOP_CONFIG.md)**\n\n## \ud83c\udfaf Assistance Levels\n\n### \ud83e\udded GUIDED Mode\n- **Purpose**: Learning through discovery\n- **Approach**: Socratic questioning and guided exploration\n- **Best For**: New concepts, skill building, deep understanding\n- **Example**: \"What do you think JWT stands for? How might stateless authentication work?\"\n\n### \ud83d\udcda EXPLAINED Mode \n- **Purpose**: Education with solutions\n- **Approach**: Detailed explanations with implementation\n- **Best For**: Time-sensitive tasks with learning value\n- **Example**: \"Here's how JWT works... [detailed explanation] + working code\"\n\n### \ud83e\udd1d ASSISTED Mode\n- **Purpose**: Quick help with learning opportunities\n- **Approach**: Direct help with educational context\n- **Best For**: Experienced developers needing quick assistance\n- **Example**: \"Use this JWT library. Key security considerations: [brief points]\"\n\n### \u26a1 AUTOMATED Mode\n- **Purpose**: Direct task completion\n- **Approach**: Efficient solutions without educational overhead\n- **Best For**: Production pressure, repeated tasks\n- **Example**: \"Here's the complete JWT implementation.\"\n\n## \ud83d\udee0\ufe0f MCP Tools\n\nThe extension provides four core MCP tools that work seamlessly with Goose:\n\n### `mentor_analyze_request`\nAnalyzes user requests for learning opportunities and recommends assistance levels.\n\n**Parameters:**\n- `request`: The user's request or question\n- `context`: Optional context about the current task or project\n\n### `mentor_learning_check`\nValidates understanding through Socratic questioning and provides learning feedback.\n\n**Parameters:**\n- `concept`: The concept or topic to validate understanding for\n- `user_response`: User's response to previous questions (optional)\n- `assistance_level`: Level of assistance (guided, explained, assisted, automated)\n\n### `mentor_track_progress`\nTracks learning progress and provides recommendations for continued development.\n\n**Parameters:**\n- `topic`: The learning topic or subject area\n- `interaction_data`: Data about the learning interaction\n- `session_id`: Optional session identifier for progress tracking\n\n### `mentor_suggest_assistance_level`\nSuggests the optimal assistance level based on request complexity and user profile.\n\n**Parameters:**\n- `request`: The user's request or task\n- `user_profile`: Optional user profile information\n- `context`: Optional context about the current situation\n\n> **Note**: These tools are automatically available in Goose once the extension is installed. Goose will intelligently use them based on your interactions to provide mentoring assistance.\n\n## \ud83c\udf93 Educational Philosophy\n\nMentor Mode transforms AI assistance from automation to education:\n\n- **Discovery Over Delivery**: Help users understand *why*, not just *how*\n- **Adaptive Learning**: Adjusts approach based on experience and context \n- **Progressive Complexity**: Builds understanding layer by layer\n- **Retention Focus**: Emphasizes learning that sticks\n\n## \ud83d\udd27 Developer Profiles\n\n### New Developer (0-6 months)\n```bash\nDEFAULT_ASSISTANCE_LEVEL=guided\nLEARNING_PHASE=onboarding\nTIMELINE_PRESSURE=low\nENABLE_VALIDATION_CHECKPOINTS=true\n```\n\n### Developing Skills (6-24 months)\n```bash\nDEFAULT_ASSISTANCE_LEVEL=explained\nLEARNING_PHASE=skill_building\nTIMELINE_PRESSURE=medium\nENABLE_VALIDATION_CHECKPOINTS=true\n```\n\n### Experienced Developer (24+ months)\n```bash\nDEFAULT_ASSISTANCE_LEVEL=assisted\nLEARNING_PHASE=production\nTIMELINE_PRESSURE=medium\nENABLE_VALIDATION_CHECKPOINTS=false\n```\n\n## \ud83e\uddea Testing\n\n```bash\n# Run all tests\nuv run pytest\n\n# Run with coverage\nuv run pytest --cov=goose_mentor_mode\n\n# Run specific test\nuv run pytest tests/test_mentor_toolkit.py::TestMentorToolkit::test_mentor_analyze_request\n```\n\n## \ud83e\udd1d Contributing\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Make your changes\n4. Add tests for new functionality\n5. Run tests (`uv run pytest`)\n6. Commit your changes (`git commit -m 'Add amazing feature'`)\n7. Push to the branch (`git push origin feature/amazing-feature`)\n8. Open a Pull Request\n\n## \ud83d\udcdd License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude4f Acknowledgments\n\n- Built for the [Goose AI Assistant](https://github.com/block/goose)\n- Inspired by Socratic teaching methods\n- Designed for developers who value learning\n\n## \ud83d\udcde Support\n\n- **Issues**: [GitHub Issues](https://github.com/joeeuston-dev/goose-mentor-mode/issues)\n- **Documentation**: [GitHub Wiki](https://github.com/joeeuston-dev/goose-mentor-mode/wiki)\n- **Discussions**: [GitHub Discussions](https://github.com/joeeuston-dev/goose-mentor-mode/discussions)\n\n---\n\n**Transform your AI assistance from automation to education with Goose Mentor Mode! \ud83c\udf93\u2728**\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI-powered mentor extension for Goose that transforms automation into guided learning",
"version": "0.1.6",
"project_urls": {
"Documentation": "https://github.com/joeeuston-dev/goose-mentor-mode/blob/main/README.md",
"Homepage": "https://github.com/joeeuston-dev/goose-mentor-mode",
"Issues": "https://github.com/joeeuston-dev/goose-mentor-mode/issues",
"Repository": "https://github.com/joeeuston-dev/goose-mentor-mode"
},
"split_keywords": [
"ai",
" development",
" goose",
" learning",
" mcp",
" mentor"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bcf126f5d547eb6e453c082d83b266a762d62ed952228fa5fdbc9eb79012f091",
"md5": "1e98d6d2bd6827c8df3fbe6adca6c122",
"sha256": "8250a014907eb73e859c4789163092a2a2e8ae3bc67dbd98959deb6ca168e94d"
},
"downloads": -1,
"filename": "goose_mentor_mode-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e98d6d2bd6827c8df3fbe6adca6c122",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 17613,
"upload_time": "2025-08-08T10:49:39",
"upload_time_iso_8601": "2025-08-08T10:49:39.406918Z",
"url": "https://files.pythonhosted.org/packages/bc/f1/26f5d547eb6e453c082d83b266a762d62ed952228fa5fdbc9eb79012f091/goose_mentor_mode-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "321b03e5dfa6ffefc0a1df49daa44069c8ea89103edfe777e3e52c252b5b9fcd",
"md5": "c655d1b446dd66ff093f96cd09ad0019",
"sha256": "9c20557d9a35cead9c894b67a2e57c567668f8b85a6b4989aa312beec094d30d"
},
"downloads": -1,
"filename": "goose_mentor_mode-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "c655d1b446dd66ff093f96cd09ad0019",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 15891,
"upload_time": "2025-08-08T10:49:40",
"upload_time_iso_8601": "2025-08-08T10:49:40.797542Z",
"url": "https://files.pythonhosted.org/packages/32/1b/03e5dfa6ffefc0a1df49daa44069c8ea89103edfe777e3e52c252b5b9fcd/goose_mentor_mode-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-08 10:49:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joeeuston-dev",
"github_project": "goose-mentor-mode",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "goose-mentor-mode"
}