237 lines
9.4 KiB
Python
Raw Normal View History

"""
MCP Documentation component for SuperClaude MCP server documentation
"""
from typing import Dict, List, Tuple, Optional, Any
from pathlib import Path
from ..core.base import Component
from ..services.claude_md import CLAUDEMdService
class MCPDocsComponent(Component):
"""MCP documentation component - installs docs for selected MCP servers"""
def __init__(self, install_dir: Optional[Path] = None):
"""Initialize MCP docs component"""
# Initialize attributes before calling parent constructor
# because parent calls _discover_component_files() which needs these
self.selected_servers: List[str] = []
# Map server names to documentation files
self.server_docs_map = {
"context7": "MCP_Context7.md",
"sequential": "MCP_Sequential.md",
"magic": "MCP_Magic.md",
"playwright": "MCP_Playwright.md",
"serena": "MCP_Serena.md",
"morphllm": "MCP_Morphllm.md"
}
super().__init__(install_dir, Path(""))
def get_metadata(self) -> Dict[str, str]:
"""Get component metadata"""
return {
"name": "mcp_docs",
Fix component validation and bump version to 4.0.6 (#292) * ✨ Enhance documentation with advanced markdown formatting Major improvements to documentation presentation and usability: README.md: - Added centered hero section with framework statistics dashboard - Created visual support section with donation cards - Enhanced What's New section with feature grid layout - Reorganized documentation links into categorized table - Added professional badges and visual separators installation.md: - Centered title with platform badges and quick navigation - Consolidated 4 installation methods into unified table - Created visual requirement cards (Required vs Optional) - Added collapsible troubleshooting sections - Removed 3 duplicate "What's Next" sections - Enhanced learning journey with progression tables quick-start.md: - Added visual framework architecture flow diagram - Created component statistics dashboard (21|14|6|6) - Built comparison table for SuperClaude vs Standard Claude - Added 4-week learning timeline with milestones - Enhanced workflow patterns with step-by-step tables - Created key insights cards explaining framework philosophy All documents now feature consistent styling with centered titles, organized tables, emojis for visual scanning, and improved navigation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🔥 Remove outdated publishing and release instruction files Cleaned up repository by removing: - PUBLISHING.md: Outdated publishing guidelines - RELEASE_INSTRUCTIONS.md: Old release process documentation These files are no longer needed as the project has evolved and the processes have been streamlined or moved elsewhere. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🐛 Fix component validation to check metadata file instead of settings.json Resolves #291 - Validation errors after V4 upgrade ## Changes - Fixed validation logic to check .superclaude-metadata.json instead of settings.json - Standardized all component versions to 4.0.4 across the framework - Fixed agent validation to check for correct filenames (architect vs specialist/engineer) - Cleaned up metadata file structure for consistency ## Technical Details The issue was caused by components registering in .superclaude-metadata.json but validation checking settings.json for component registration. This mismatch caused false validation errors even though components were properly installed. ## Testing All components now validate successfully with the corrected logic. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🔖 Bump version to 4.0.6 across entire project ## Summary Comprehensive version update from 4.0.4 to 4.0.6 with validation fixes ## Changes - Updated VERSION file, pyproject.toml, and package.json - Updated all Python __version__ declarations (8 occurrences) - Updated all component metadata versions (6 components, 25+ occurrences) - Updated documentation and README version badges (11 files) - Fixed package.json inconsistency (was 4.0.5) - Updated legacy backup.py version reference (was 3.0.0) - Added CHANGELOG entry for version 4.0.6 ## Files Modified (26 total) - Core: VERSION, pyproject.toml, package.json - Python: SuperClaude/__init__.py, __main__.py, setup/__init__.py, cli/base.py - Components: core.py, commands.py, agents.py, mcp.py, mcp_docs.py, modes.py - Docs: README.md, CONTRIBUTING.md, SECURITY.md, installation.md, quick-start.md - Config: features.json, backup.py, update.py - User: ~/.claude/.superclaude-metadata.json ## Verification All version references now consistently show 4.0.6 Historical references in CHANGELOG preserved as intended 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 📝 Update README.md installation instructions --------- Signed-off-by: NomenAK <39598727+NomenAK@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
2025-08-23 12:08:09 +02:00
"version": "4.0.6",
"description": "MCP server documentation and usage guides",
"category": "documentation"
}
def set_selected_servers(self, selected_servers: List[str]) -> None:
"""Set which MCP servers were selected for documentation installation"""
self.selected_servers = selected_servers
self.logger.debug(f"MCP docs will be installed for: {selected_servers}")
def get_files_to_install(self) -> List[Tuple[Path, Path]]:
"""
Return list of files to install based on selected MCP servers
Returns:
List of tuples (source_path, target_path)
"""
source_dir = self._get_source_dir()
files = []
if source_dir and self.selected_servers:
for server_name in self.selected_servers:
if server_name in self.server_docs_map:
doc_file = self.server_docs_map[server_name]
source = source_dir / doc_file
target = self.install_dir / doc_file
if source.exists():
files.append((source, target))
self.logger.debug(f"Will install documentation for {server_name}: {doc_file}")
else:
self.logger.warning(f"Documentation file not found for {server_name}: {doc_file}")
return files
def _discover_component_files(self) -> List[str]:
"""
Override parent method to dynamically discover files based on selected servers
"""
files = []
# Check if selected_servers is not empty
if self.selected_servers:
for server_name in self.selected_servers:
if server_name in self.server_docs_map:
files.append(self.server_docs_map[server_name])
return files
def _install(self, config: Dict[str, Any]) -> bool:
"""Install MCP documentation component"""
self.logger.info("Installing MCP server documentation...")
# Get selected servers from config
selected_servers = config.get("selected_mcp_servers", [])
if not selected_servers:
self.logger.info("No MCP servers selected - skipping documentation installation")
return True
self.set_selected_servers(selected_servers)
# Update component files based on selection
self.component_files = self._discover_component_files()
# Validate installation
success, errors = self.validate_prerequisites()
if not success:
for error in errors:
self.logger.error(error)
return False
# Get files to install
files_to_install = self.get_files_to_install()
if not files_to_install:
self.logger.warning("No MCP documentation files found to install")
return True # Not an error - just no docs to install
# Copy documentation files
success_count = 0
for source, target in files_to_install:
self.logger.debug(f"Copying {source.name} to {target}")
if self.file_manager.copy_file(source, target):
success_count += 1
self.logger.debug(f"Successfully copied {source.name}")
else:
self.logger.error(f"Failed to copy {source.name}")
if success_count != len(files_to_install):
self.logger.error(f"Only {success_count}/{len(files_to_install)} documentation files copied successfully")
return False
self.logger.success(f"MCP documentation installed successfully ({success_count} files for {len(selected_servers)} servers)")
return self._post_install()
def _post_install(self) -> bool:
"""Post-installation tasks"""
try:
# Update metadata
metadata_mods = {
"components": {
"mcp_docs": {
Fix component validation and bump version to 4.0.6 (#292) * ✨ Enhance documentation with advanced markdown formatting Major improvements to documentation presentation and usability: README.md: - Added centered hero section with framework statistics dashboard - Created visual support section with donation cards - Enhanced What's New section with feature grid layout - Reorganized documentation links into categorized table - Added professional badges and visual separators installation.md: - Centered title with platform badges and quick navigation - Consolidated 4 installation methods into unified table - Created visual requirement cards (Required vs Optional) - Added collapsible troubleshooting sections - Removed 3 duplicate "What's Next" sections - Enhanced learning journey with progression tables quick-start.md: - Added visual framework architecture flow diagram - Created component statistics dashboard (21|14|6|6) - Built comparison table for SuperClaude vs Standard Claude - Added 4-week learning timeline with milestones - Enhanced workflow patterns with step-by-step tables - Created key insights cards explaining framework philosophy All documents now feature consistent styling with centered titles, organized tables, emojis for visual scanning, and improved navigation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🔥 Remove outdated publishing and release instruction files Cleaned up repository by removing: - PUBLISHING.md: Outdated publishing guidelines - RELEASE_INSTRUCTIONS.md: Old release process documentation These files are no longer needed as the project has evolved and the processes have been streamlined or moved elsewhere. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🐛 Fix component validation to check metadata file instead of settings.json Resolves #291 - Validation errors after V4 upgrade ## Changes - Fixed validation logic to check .superclaude-metadata.json instead of settings.json - Standardized all component versions to 4.0.4 across the framework - Fixed agent validation to check for correct filenames (architect vs specialist/engineer) - Cleaned up metadata file structure for consistency ## Technical Details The issue was caused by components registering in .superclaude-metadata.json but validation checking settings.json for component registration. This mismatch caused false validation errors even though components were properly installed. ## Testing All components now validate successfully with the corrected logic. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🔖 Bump version to 4.0.6 across entire project ## Summary Comprehensive version update from 4.0.4 to 4.0.6 with validation fixes ## Changes - Updated VERSION file, pyproject.toml, and package.json - Updated all Python __version__ declarations (8 occurrences) - Updated all component metadata versions (6 components, 25+ occurrences) - Updated documentation and README version badges (11 files) - Fixed package.json inconsistency (was 4.0.5) - Updated legacy backup.py version reference (was 3.0.0) - Added CHANGELOG entry for version 4.0.6 ## Files Modified (26 total) - Core: VERSION, pyproject.toml, package.json - Python: SuperClaude/__init__.py, __main__.py, setup/__init__.py, cli/base.py - Components: core.py, commands.py, agents.py, mcp.py, mcp_docs.py, modes.py - Docs: README.md, CONTRIBUTING.md, SECURITY.md, installation.md, quick-start.md - Config: features.json, backup.py, update.py - User: ~/.claude/.superclaude-metadata.json ## Verification All version references now consistently show 4.0.6 Historical references in CHANGELOG preserved as intended 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 📝 Update README.md installation instructions --------- Signed-off-by: NomenAK <39598727+NomenAK@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
2025-08-23 12:08:09 +02:00
"version": "4.0.6",
"installed": True,
"files_count": len(self.component_files),
"servers_documented": self.selected_servers
}
}
}
self.settings_manager.update_metadata(metadata_mods)
self.logger.info("Updated metadata with MCP docs component registration")
# Update CLAUDE.md with MCP documentation imports
try:
manager = CLAUDEMdService(self.install_dir)
manager.add_imports(self.component_files, category="MCP Documentation")
self.logger.info("Updated CLAUDE.md with MCP documentation imports")
except Exception as e:
self.logger.warning(f"Failed to update CLAUDE.md with MCP documentation imports: {e}")
# Don't fail the whole installation for this
return True
except Exception as e:
self.logger.error(f"Failed to update metadata: {e}")
return False
def uninstall(self) -> bool:
"""Uninstall MCP documentation component"""
try:
self.logger.info("Uninstalling MCP documentation component...")
# Remove all MCP documentation files
removed_count = 0
source_dir = self._get_source_dir()
if source_dir and source_dir.exists():
# Remove all possible MCP doc files
for doc_file in self.server_docs_map.values():
file_path = self.install_component_subdir / doc_file
if self.file_manager.remove_file(file_path):
removed_count += 1
self.logger.debug(f"Removed {doc_file}")
# Remove mcp directory if empty
try:
if self.install_component_subdir.exists():
remaining_files = list(self.install_component_subdir.iterdir())
if not remaining_files:
self.install_component_subdir.rmdir()
self.logger.debug("Removed empty mcp directory")
except Exception as e:
self.logger.warning(f"Could not remove mcp directory: {e}")
# Update settings.json
try:
if self.settings_manager.is_component_installed("mcp_docs"):
self.settings_manager.remove_component_registration("mcp_docs")
self.logger.info("Removed MCP docs component from settings.json")
except Exception as e:
self.logger.warning(f"Could not update settings.json: {e}")
self.logger.success(f"MCP documentation uninstalled ({removed_count} files removed)")
return True
except Exception as e:
self.logger.exception(f"Unexpected error during MCP docs uninstallation: {e}")
return False
def get_dependencies(self) -> List[str]:
"""Get dependencies"""
return ["core"]
def _get_source_dir(self) -> Optional[Path]:
"""Get source directory for MCP documentation files"""
# Assume we're in SuperClaude/setup/components/mcp_docs.py
# and MCP docs are in SuperClaude/SuperClaude/MCP/
project_root = Path(__file__).parent.parent.parent
mcp_dir = project_root / "SuperClaude" / "MCP"
# Return None if directory doesn't exist to prevent warning
if not mcp_dir.exists():
return None
return mcp_dir
def get_size_estimate(self) -> int:
"""Get estimated installation size"""
source_dir = self._get_source_dir()
total_size = 0
if source_dir and source_dir.exists() and self.selected_servers:
for server_name in self.selected_servers:
if server_name in self.server_docs_map:
doc_file = self.server_docs_map[server_name]
file_path = source_dir / doc_file
if file_path.exists():
total_size += file_path.stat().st_size
# Minimum size estimate
total_size = max(total_size, 10240) # At least 10KB
return total_size