# π ACF Project Structure
**Author**: Abhilash Chadhar (FutureAtoms)
**Last Updated**: 2025-01-10
**Version**: 1.0
This document provides a comprehensive overview of the Agentic Control Framework repository structure after the recent reorganization.
## ποΈ Repository Overview
```
agentic-control-framework/
βββ π bin/ # CLI executables and entry points
β βββ π§ acf # Main CLI entry point for task management
β βββ π§ agentic-control-framework-mcp # Primary MCP server for IDE integration
β βββ π§ task-manager # Task management CLI
β βββ π§ task-manager-mcp # Task manager MCP server
β βββ π§ task-cli.js # Alternative CLI interface
β
βββ π src/ # Core source code
β βββ π§ core.js # Core task management logic
β βββ π§ cli.js # CLI command definitions
β βββ π§ mcp/server.js # Unified MCP server (JSON-RPC over stdio)
β βββ π§ auth-proxy.js # Authentication proxy for cloud
β βββ π§ filesystem_tools.js # Filesystem operations
β βββ π§ prd_parser.js # AI-powered PRD parsing
β βββ π§ tableRenderer.js # Task table rendering
β βββ π§ logger.js # Standardized logging
β βββ π§ file_watcher.js # File system monitoring
β βββ π§ dependency_manager.js # Dependency management
β βββ π§ priority_engine.js # Task priority system
β βββ π§ priority_functions.js # Priority calculation functions
β βββ π§ priority_log_cleanup.js # Priority logging cleanup
β βββ π§ priority_templates.js # Priority templates
β βββ π§ rules_template.mdc # Rules template
β β
β βββ π tools/ # Tool implementations
β βββ π§ browser_tools.js # Browser automation (Playwright)
β βββ π§ terminal_tools.js # Command execution
β βββ π§ search_tools.js # Advanced code search
β βββ π§ edit_tools.js # Text editing operations
β βββ π§ applescript_tools.js # macOS automation
β βββ π§ enhanced_filesystem_tools.js # Extended filesystem ops
β
βββ π docs/ # Documentation (ORGANIZED)
β βββ π README.md # Documentation index
β βββ π ARCHITECTURE.md # System architecture
β βββ π CLAUDE_CODE_SETUP_GUIDE.md # Claude Code integration
β βββ π COMPLETE_TUTORIAL.md # Comprehensive tutorial
β βββ π DEPLOYMENT_GUIDE.md # Deployment guide
β βββ π MCP_INTEGRATION_GUIDE.md # MCP protocol integration
β βββ π TESTING_SUMMARY.md # Testing methodology
β βββ π TOOL_REFERENCE.md # Complete tool reference
β βββ π enhanced-mcp-tools.md # Enhanced tool docs
β βββ π migration-guide.md # Migration procedures
β βββ π priority-system.md # Priority system docs
β βββ π priority-examples.md # Priority examples
β βββ π tutorial.md # Basic tutorial
β βββ π workspace-indexing-proposal.md # Workspace indexing
β β
β βββ π setup/ # Setup and installation guides
β β βββ π SETUP-INSTRUCTIONS.md # Installation guide
β β βββ π CURSOR-SETUP-GUIDE.md # Cursor IDE setup
β β βββ π WORKING-EXAMPLE.md # Live examples
β β
β βββ π deployment/ # Cloud deployment guides
β β βββ π GCP-DEPLOYMENT-GUIDE.md # Google Cloud Platform
β β βββ π PLATFORM-SETUP-GUIDE.md # Multi-platform setup
β β βββ π MCP-PROXY-DEPLOYMENT.md # MCP proxy deployment
β β βββ π REMOTE-CLIENT-SETUP.md # Remote client config
β β βββ π DEPLOYMENT-STATUS.md # Deployment status
β β βββ π DEPLOYMENT-SUCCESS-SUMMARY.md # Deployment verification
β β
β βββ π testing/ # Test reports and results
β β βββ π CLOUD-MCP-COMPREHENSIVE-TEST-REPORT.md # Latest cloud testing
β β βββ π CLOUD-DEPLOYMENT-TEST-RESULTS.md # Cloud platform testing
β β βββ π DOCKER-CONTAINER-TEST-RESULTS.md # Container testing
β β βββ π AUTHENTICATION-SECURITY-TEST-RESULTS.md # Security testing
β β βββ π TOOL_CATEGORY_VERIFICATION_REPORT.md # Tool verification
β β βββ π COMPREHENSIVE_FUNCTIONALITY_TEST_REPORT.md # Functionality testing
β β
β βββ π reference/ # Reference materials
β β βββ π QUICK-REFERENCE.md # Quick command reference
β β βββ π RELEASE-GUIDE.md # Release process
β β βββ π CONSUMER-GRADE-RELEASE-SUMMARY.md # Consumer release
β β βββ π MANUS_LIKE_ENHANCEMENT_PLAN.md # Enhancement roadmap
β β βββ π REPOSITORY-ORGANIZATION-SUMMARY.md # Repository structure
β β βββ π CHANGES.md # Version history
β β βββ π DOCUMENTATION_UPDATE_CHANGELOG.md # Documentation changes
β β
β βββ π mcp-protocol/ # MCP protocol documentation
β β βββ π architecture.mdx # MCP architecture
β β βββ π building-a-client-node.mdx # Client development
β β βββ π building-mcp-with-llms.mdx # LLM integration
β β βββ π client.mdx # Client documentation
β β βββ π clients.mdx # Client implementations
β β βββ π debugging.mdx # Debugging guide
β β βββ π examples.mdx # Protocol examples
β β βββ π inspector.mdx # Protocol inspector
β β βββ π introduction.mdx # Protocol introduction
β β βββ π prompts.mdx # Prompt handling
β β βββ π resources.mdx # Resource management
β β βββ π roots.mdx # Root concepts
β β βββ π sampling.mdx # Sampling methods
β β βββ π server.mdx # Server documentation
β β βββ π tools.mdx # Tool documentation
β β βββ π transports.mdx # Transport layers
β β βββ π user.mdx # User guide
β β
β βββ π mcp-integration/ # MCP integration guides
β βββ π tutorials/ # Tutorial materials
β βββ π architecture/ # Architecture documentation
β βββ π client-guides/ # Client-specific guides
β
βββ π test/ # Testing infrastructure (ORGANIZED)
β βββ π README.md # Testing framework overview
β βββ π§ comprehensive-mcp-test.js # Consolidated test suite
β βββ π§ mcp-response-test.js # MCP response testing
β βββ π§ mcp-server-response-test.js # Server response testing
β βββ π§ priority-logging-test.js # Priority logging tests
β βββ π§ simple-response-test.js # Simple response tests
β βββ π§ task-table-format-test.js # Task table format tests
β βββ π§ run-all-tests.sh # Test runner script
β β
β βββ π cloud/ # Cloud testing scripts (MOVED FROM ROOT)
β β βββ π§ test-mcp-proxy-manual.js # Manual MCP proxy testing
β β βββ π§ test-endpoints.js # Endpoint testing
β β βββ π§ test-mcp-workflow.js # MCP workflow testing
β β βββ π§ test-remote-client-configs.js # Remote client testing
β β βββ π§ test-all-client-configs.js # All client config testing
β β βββ π§ test-auth-security.js # Authentication testing
β β βββ π§ test-docker-configurations.sh # Docker configuration testing
β β
β βββ π unit/ # Unit tests
β βββ π integration/ # Integration tests
β βββ π e2e/ # End-to-end tests
β βββ π performance/ # Performance tests
β βββ π fixtures/ # Test data and fixtures
β βββ π reports/ # Test reports
β βββ π claude-code/ # Claude Code specific tests
β βββ π cli/ # CLI testing
β βββ π mcp/ # MCP protocol tests
β
βββ π config/ # Configuration files (ORGANIZED)
β βββ π client-configurations/ # MCP client configs (MOVED FROM ROOT)
β β βββ π README.md # Client configuration guide
β β βββ π claude-code-remote.json # Claude Code remote config
β β βββ π claude-desktop-config.json # Claude Desktop config
β β βββ π claude-desktop-remote.json # Claude Desktop remote
β β βββ π cursor-remote.json # Cursor remote config
β β βββ π cursor-settings.json # Cursor settings
β β βββ π vscode-settings.json # VS Code settings
β β βββ π windsurf-config.json # Windsurf configuration
β β
β βββ π examples/ # Example configurations (MOVED FROM ROOT)
β β βββ π config.json # Main configuration
β β βββ π env.example # Environment variables
β β βββ π mcp-connection.json # MCP connection config
β β βββ π mcp-proxy-config.yaml # MCP proxy configuration
β β βββ π railway.json # Railway deployment
β β βββ π smithery.yaml # Smithery configuration
β β βββ π settings.json # User settings
β β
β βββ π templates/ # Configuration templates
β
βββ π scripts/ # Utility scripts (ORGANIZED)
β βββ π setup/ # Setup scripts (MOVED FROM ROOT)
β β βββ π§ setup.sh # Main setup script
β β βββ π§ setup-claude-code.sh # Claude Code setup
β β
β βββ π deployment/ # Deployment scripts (MOVED FROM ROOT)
β β βββ π§ quick-deploy.sh # One-command deployment
β β
β βββ π maintenance/ # Maintenance scripts (MOVED FROM ROOT)
β β βββ π§ compare-upstream-tools.js # Tool comparison
β β βββ π§ sync-upstream.sh # Upstream synchronization
β β
β βββ π testing/ # Testing scripts
β
βββ π deployment/ # Deployment configurations
β βββ π README.md # Deployment overview
β β
β βββ π docker/ # Docker files (MOVED FROM ROOT)
β β βββ π§ Dockerfile # Main Docker image
β β βββ π§ Dockerfile.proxy # Proxy Docker image
β β βββ π§ docker-compose.yml # Multi-container setup
β β
β βββ π cloud-run/ # Google Cloud Run
β βββ π railway/ # Railway deployment
β βββ π fly/ # Fly.io deployment
β
βββ π tasks/ # Task management files
β βββ π tasks-table.md # Human-readable task table
β βββ π Individual task files (auto-generated)
β
βββ π templates/ # Project templates
β βββ π initial_tasks.json # Initial task templates
β
βββ π public/ # Static assets
β βββ π index.html # Web interface
β
βββ π data/ # Data directory
β
βββ π Root Files
βββ π README.md # Main project documentation
βββ π package.json # Node.js dependencies
βββ π package-lock.json # Dependency lock file
βββ π DOCUMENTATION-INDEX.md # Documentation index
βββ π PR_DESCRIPTION.md # Pull request description
βββ π REPOSITORY-CLEANUP-COMPLETED.md # Cleanup completion summary
βββ π agentic-control-framework.png # Project logo
βββ π demo.gif # Demo animation
```
## π§ Key Components Explained
### Core Executables (`bin/`)
- **`acf`**: Main CLI entry point for task management
- **`agentic-control-framework-mcp`**: Primary MCP server for IDE integration
- **`task-manager`**: Task management CLI interface
- **`task-cli.js`**: Alternative CLI with enhanced features
### Source Code (`src/`)
- **`core.js`**: Core task management logic and data structures
- **`src/mcp/server.js`**: Unified MCP server (main server file)
- **`auth-proxy.js`**: Authentication proxy for cloud deployment
- **`filesystem_tools.js`**: Filesystem operations for MCP integration
### Tool Categories (`src/tools/`)
- **Browser Tools**: Playwright-based browser automation
- **Terminal Tools**: Command execution and process management
- **Search Tools**: Advanced code search with ripgrep
- **Edit Tools**: Surgical text editing and replacement
- **AppleScript Tools**: macOS automation and system integration
- **Filesystem Tools**: Enhanced file and directory operations
### Documentation System (`docs/`)
- **Organized by category**: Setup, deployment, testing, reference
- **Complete coverage**: All aspects from installation to production
- **Cross-referenced**: Internal links maintain navigation
- **Version controlled**: All documentation reflects current state
### Testing Infrastructure (`test/`)
- **Comprehensive test suites**: 100% pass rate across all configurations
- **Cloud testing**: Dedicated cloud testing scripts in `test/cloud/`
- **Multiple test types**: Unit, integration, e2e, performance
- **IDE integration testing**: Cursor, Claude Desktop, Claude Code, VS Code
### Configuration Management (`config/`)
- **Client configurations**: MCP client setup examples
- **Example configurations**: Template files for all services
- **Environment templates**: Secure configuration examples
### Deployment Support (`deployment/`)
- **Docker support**: Multi-container deployment configurations
- **Cloud platforms**: GCP, Railway, Fly.io deployment configs
- **Automated deployment**: One-command deployment scripts
## π Organization Benefits
### β
Clean Separation of Concerns
- Source code in `src/`
- Documentation in `docs/`
- Tests in `test/`
- Configuration in `config/`
- Scripts in `scripts/`
### β
Improved Navigation
- Logical directory structure
- Category-based organization
- Clear file naming conventions
- Comprehensive documentation index
### β
Better Maintainability
- Related files grouped together
- Standard repository practices
- Easy to find and update files
- Professional appearance
### β
Preserved Functionality
- All scripts updated with correct paths
- All documentation links maintained
- No functionality lost in reorganization
- All tools and features working
---
**Structure Version**: 1.0 (Post-Cleanup)
**Last Updated**: 2025-01-10
**Status**: β
Organized and Production-Ready