firefrost-gaming/skill-seekers-reference
3
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
354 Commits 1 Branch 0 Tags
bd974148a24f996724632ee620d5fc54152a31ea
Commit Graph

2 Commits

Author SHA1 Message Date
MiaoDX
bd974148a2 feat: Update MCP to use server_fastmcp with venv Python support 
This PR improves MCP server configuration by updating all documentation
to use the current server_fastmcp module and ensuring setup scripts
automatically use virtual environment Python instead of system Python.

## Changes

### 1. Documentation Updates (server → server_fastmcp)

Updated all references from deprecated `server` module to `server_fastmcp`:

**User-facing documentation:**
- examples/http_transport_examples.sh: All 13 command examples
- README.md: Configuration examples and troubleshooting commands
- docs/guides/MCP_SETUP.md: Enhanced migration guide with stdio/HTTP examples
- docs/guides/TESTING_GUIDE.md: Test import statements
- docs/guides/MULTI_AGENT_SETUP.md: Updated examples
- docs/guides/SETUP_QUICK_REFERENCE.md: Updated paths
- CLAUDE.md: CLI command examples

**MCP module:**
- src/skill_seekers/mcp/README.md: Updated config examples
- src/skill_seekers/mcp/agent_detector.py: Use server_fastmcp module

Note: Historical release notes (CHANGELOG.md) preserved unchanged.

### 2. Venv Python Configuration

**setup_mcp.sh improvements:**
- Added automatic venv detection (checks .venv, venv, and $VIRTUAL_ENV)
- Sets PYTHON_CMD to venv Python path when available
- **CRITICAL FIX**: Now updates PYTHON_CMD after creating/activating venv
- Generates MCP configs with full venv Python path
- Falls back to system python3 if no venv found
- Displays detected Python version and path

**Config examples updated:**
- .claude/mcp_config.example.json: Use venv Python path
- example-mcp-config.json: Use venv Python path
- Added "type": "stdio" for clarity
- Updated to use server_fastmcp module

### 3. Bug Fix: PYTHON_CMD Not Updated After Venv Creation

Previously, when setup_mcp.sh created or activated a venv, it failed to
update PYTHON_CMD, causing generated configs to still use system python3.

**Fixed cases:**
- When $VIRTUAL_ENV is already set → Update PYTHON_CMD to venv Python
- When existing venv is activated → Set PYTHON_CMD="$REPO_PATH/venv/bin/python3"
- When new venv is created → Set PYTHON_CMD="$REPO_PATH/venv/bin/python3"

## Benefits

### For Users:
✅ No deprecation warnings - All docs show current module
✅ Proper Python environment - MCP uses venv with all dependencies
✅ No system Python issues - Avoids "module not found" errors
✅ No global installation needed - No --break-system-packages required
✅ Automatic detection - setup_mcp.sh finds venv automatically
✅ Clean isolation - Projects don't interfere with system Python

### For Maintainers:
✅ Prepared for v3.0.0 - Documentation ready for server.py removal
✅ Reduced support burden - Fewer MCP configuration issues
✅ Consistent examples - All docs use same module/pattern

## Testing

**Verified:**
- ✅ All command examples use server_fastmcp
- ✅ No deprecated module references in user-facing docs (0 results)
- ✅ New module correctly referenced (129 instances)
- ✅ setup_mcp.sh detects venv and generates correct config
- ✅ PYTHON_CMD properly updated after venv creation
- ✅ MCP server starts correctly with venv Python

**Files changed:** 12 files (+262/-107 lines)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-18 15:55:46 +08:00
yusyus
6f1d0a9a45 docs: Comprehensive markdown documentation update for v2.7.0 
Documentation Overhaul (7 new files, ~4,750 lines)

Version Consistency Updates:
- Updated all version references to v2.7.0 (ROADMAP.md)
- Standardized test counts to 1200+ tests (README.md, Quality Assurance)
- Updated MCP tool references to 18 tools (CHANGELOG.md)

New Documentation Files:
1. docs/reference/API_REFERENCE.md (750 lines)
   - Complete programmatic usage guide for Python integration
   - All 8 core APIs documented with examples
   - Configuration schema reference and error handling
   - CI/CD integration examples (GitHub Actions, GitLab CI)
   - Performance optimization and batch processing

2. docs/features/BOOTSTRAP_SKILL.md (450 lines)
   - Self-hosting capability documentation (dogfooding)
   - Architecture and workflow explanation (3 components)
   - Troubleshooting and testing guide
   - CI/CD integration examples
   - Advanced usage and customization

3. docs/reference/CODE_QUALITY.md (550 lines)
   - Comprehensive Ruff linting documentation
   - All 21 v2.7.0 fixes explained with examples
   - Testing requirements and coverage standards
   - CI/CD integration (GitHub Actions, pre-commit hooks)
   - Security scanning with Bandit
   - Development workflow best practices

4. docs/guides/TESTING_GUIDE.md (750 lines)
   - Complete testing reference (1200+ tests)
   - Unit, integration, E2E, and MCP testing guides
   - Coverage analysis and improvement strategies
   - Debugging tests and troubleshooting
   - CI/CD matrix testing (2 OS, 4 Python versions)
   - Best practices and common patterns

5. docs/QUICK_REFERENCE.md (300 lines)
   - One-page cheat sheet for quick lookup
   - All CLI commands with examples
   - Common workflows and shortcuts
   - Environment variables and configurations
   - Tips & tricks for power users

6. docs/guides/MIGRATION_GUIDE.md (400 lines)
   - Version upgrade guides (v1.0.0 → v2.7.0)
   - Breaking changes and migration steps
   - Compatibility tables for all versions
   - Rollback instructions
   - Common migration issues and solutions

7. docs/FAQ.md (550 lines)
   - Comprehensive Q&A covering all major topics
   - Installation, usage, platforms, features
   - Troubleshooting shortcuts
   - Platform-specific questions
   - Advanced usage and programmatic integration

Navigation Improvements:
- Added "New in v2.7.0" section to docs/README.md
- Integrated all new docs into navigation structure
- Enhanced "Finding What You Need" section with new entries
- Updated developer quick links (testing, code quality, API)
- Cross-referenced related documentation

Documentation Quality:
- All version references consistent (v2.7.0)
- Test counts standardized (1200+ tests)
- MCP tool counts accurate (18 tools)
- All internal links validated
- Format consistency maintained
- Proper heading hierarchy

Impact:
- 64 markdown files reviewed and validated
- 7 new documentation files created (~4,750 lines)
- 4 files updated (ROADMAP, README, CHANGELOG, docs/README)
- Comprehensive coverage of all v2.7.0 features
- Enhanced developer onboarding experience
- Improved user documentation accessibility

Related Issues:
- Addresses documentation gaps identified in v2.7.0 planning
- Supports code quality improvements (21 ruff fixes)
- Documents bootstrap skill feature
- Provides migration path for users upgrading from older versions

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-18 01:16:22 +03:00