mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 17:56:46 +00:00
feat: Add Deep Research System v4.2.0 - Autonomous web research capabilities ## Overview Comprehensive implementation of Deep Research framework aligned with DR Agent architecture, enabling autonomous, adaptive, and intelligent web research capabilities. ## Key Features ### 🔬 Deep Research Agent - 15th specialized agent for comprehensive research orchestration - Adaptive planning strategies: Planning-Only, Intent-Planning, Unified Intent-Planning - Multi-hop reasoning with genealogy tracking (up to 5 hops) - Self-reflective mechanisms with confidence scoring (0.0-1.0) - Case-based learning for cross-session intelligence ### 🎯 New /sc:research Command - Intelligent web research with depth control (quick/standard/deep/exhaustive) - Parallel-first execution for optimal performance - Domain filtering and time-based search options - Automatic report generation in claudedocs/ ### 🔍 Tavily MCP Integration - 7th MCP server for real-time web search - News search with time filtering - Content extraction from search results - Multi-round searching with iterative refinement - Free tier available with optional API key ### 🎨 MODE_DeepResearch - 7th behavioral mode for systematic investigation - 6-phase workflow: Understand → Plan → TodoWrite → Execute → Track → Validate - Evidence-based reasoning with citation management - Parallel operation defaults for efficiency ## Technical Changes ### Framework Updates - Updated agent count: 14 → 15 agents - Updated mode count: 6 → 7 modes - Updated MCP server count: 6 → 7 servers - Updated command count: 24 → 25 commands ### Configuration - Added RESEARCH_CONFIG.md for research settings - Added deep_research_workflows.md with examples - Standardized file naming conventions (UPPERCASE for Core) - Removed multi-source investigation features for simplification ### Integration Points - Enhanced MCP component with remote server support - Added check_research_prerequisites() in environment.py - Created verify_research_integration.sh script - Updated all documentation guides ## Requirements - TAVILY_API_KEY environment variable (free tier available) - Node.js and npm for Tavily MCP execution ## Documentation - Complete user guide integration - Workflow examples and best practices - API configuration instructions - Depth level explanations 🤖 Generated with Claude Code Co-authored-by: moshe_anconina <moshe_a@ituran.com> Co-authored-by: Claude <noreply@anthropic.com>
343 lines
14 KiB
Python
343 lines
14 KiB
Python
"""
|
|
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 setup import __version__
|
|
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",
|
|
"sequential-thinking": "MCP_Sequential.md", # Handle both naming conventions
|
|
"magic": "MCP_Magic.md",
|
|
"playwright": "MCP_Playwright.md",
|
|
"serena": "MCP_Serena.md",
|
|
"morphllm": "MCP_Morphllm.md",
|
|
"morphllm-fast-apply": "MCP_Morphllm.md", # Handle both naming conventions
|
|
"tavily": "MCP_Tavily.md"
|
|
}
|
|
|
|
super().__init__(install_dir, Path(""))
|
|
|
|
def get_metadata(self) -> Dict[str, str]:
|
|
"""Get component metadata"""
|
|
return {
|
|
"name": "mcp_docs",
|
|
"version": __version__,
|
|
"description": "MCP server documentation and usage guides",
|
|
"category": "documentation"
|
|
}
|
|
|
|
def is_reinstallable(self) -> bool:
|
|
"""
|
|
Allow mcp_docs to be reinstalled to handle different server selections.
|
|
This enables users to add or change MCP server documentation.
|
|
"""
|
|
return True
|
|
|
|
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 _detect_existing_mcp_servers_from_config(self) -> List[str]:
|
|
"""Detect existing MCP servers from Claude Desktop config"""
|
|
detected_servers = []
|
|
|
|
try:
|
|
# Try to find Claude Desktop config file
|
|
config_paths = [
|
|
self.install_dir / "claude_desktop_config.json",
|
|
Path.home() / ".claude" / "claude_desktop_config.json",
|
|
Path.home() / ".claude.json", # Claude CLI config
|
|
Path.home() / "AppData" / "Roaming" / "Claude" / "claude_desktop_config.json", # Windows
|
|
Path.home() / "Library" / "Application Support" / "Claude" / "claude_desktop_config.json", # macOS
|
|
]
|
|
|
|
config_file = None
|
|
for path in config_paths:
|
|
if path.exists():
|
|
config_file = path
|
|
break
|
|
|
|
if not config_file:
|
|
self.logger.debug("No Claude Desktop config file found")
|
|
return detected_servers
|
|
|
|
import json
|
|
with open(config_file, 'r') as f:
|
|
config = json.load(f)
|
|
|
|
# Extract MCP server names from mcpServers section
|
|
mcp_servers = config.get("mcpServers", {})
|
|
for server_name in mcp_servers.keys():
|
|
# Map common name variations to our doc file names
|
|
normalized_name = self._normalize_server_name(server_name)
|
|
if normalized_name and normalized_name in self.server_docs_map:
|
|
detected_servers.append(normalized_name)
|
|
|
|
if detected_servers:
|
|
self.logger.info(f"Detected existing MCP servers from config: {detected_servers}")
|
|
|
|
except Exception as e:
|
|
self.logger.warning(f"Could not read Claude Desktop config: {e}")
|
|
|
|
return detected_servers
|
|
|
|
def _normalize_server_name(self, server_name: str) -> Optional[str]:
|
|
"""Normalize server name to match our documentation mapping"""
|
|
if not server_name:
|
|
return None
|
|
|
|
server_name = server_name.lower().strip()
|
|
|
|
# Map common variations to our server_docs_map keys
|
|
name_mappings = {
|
|
"context7": "context7",
|
|
"sequential-thinking": "sequential-thinking",
|
|
"sequential": "sequential-thinking",
|
|
"magic": "magic",
|
|
"playwright": "playwright",
|
|
"serena": "serena",
|
|
"morphllm": "morphllm",
|
|
"morphllm-fast-apply": "morphllm",
|
|
"morph": "morphllm"
|
|
}
|
|
|
|
return name_mappings.get(server_name)
|
|
|
|
def _install(self, config: Dict[str, Any]) -> bool:
|
|
"""Install MCP documentation component with auto-detection"""
|
|
self.logger.info("Installing MCP server documentation...")
|
|
|
|
# Auto-detect existing servers
|
|
self.logger.info("Auto-detecting existing MCP servers for documentation...")
|
|
detected_servers = self._detect_existing_mcp_servers_from_config()
|
|
|
|
# Get selected servers from config
|
|
selected_servers = config.get("selected_mcp_servers", [])
|
|
|
|
# Get previously documented servers from metadata
|
|
previous_servers = self.settings_manager.get_metadata_setting("components.mcp_docs.servers_documented", [])
|
|
|
|
# Merge all server lists
|
|
all_servers = list(set(detected_servers + selected_servers + previous_servers))
|
|
|
|
# Filter to only servers we have documentation for
|
|
valid_servers = [s for s in all_servers if s in self.server_docs_map]
|
|
|
|
if not valid_servers:
|
|
self.logger.info("No MCP servers detected or selected for documentation installation")
|
|
# Still proceed to update metadata
|
|
self.set_selected_servers([])
|
|
self.component_files = []
|
|
return self._post_install()
|
|
|
|
self.logger.info(f"Installing documentation for MCP servers: {', '.join(valid_servers)}")
|
|
if detected_servers:
|
|
self.logger.info(f" - Detected from config: {detected_servers}")
|
|
if selected_servers:
|
|
self.logger.info(f" - Newly selected: {selected_servers}")
|
|
if previous_servers:
|
|
self.logger.info(f" - Previously documented: {previous_servers}")
|
|
|
|
# Set the servers for which we'll install documentation
|
|
self.set_selected_servers(valid_servers)
|
|
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 False
|
|
|
|
# Copy documentation files
|
|
success_count = 0
|
|
successfully_copied_files = []
|
|
|
|
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
|
|
successfully_copied_files.append(source.name)
|
|
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
|
|
|
|
# Update component_files to only include successfully copied files
|
|
self.component_files = successfully_copied_files
|
|
self.logger.success(f"MCP documentation installed successfully ({success_count} files for {len(valid_servers)} servers)")
|
|
|
|
return self._post_install()
|
|
|
|
def _post_install(self) -> bool:
|
|
"""Post-installation tasks"""
|
|
try:
|
|
# Update metadata
|
|
metadata_mods = {
|
|
"components": {
|
|
"mcp_docs": {
|
|
"version": __version__,
|
|
"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 |