@boundless-oss/atlas/README.md

Atlas - MCP Server for comprehensive startup project management

# Atlas - MCP Server for Startup Project Management

Atlas is a comprehensive Model Context Protocol (MCP) server that provides 178 tools across 14 modules for building and managing startup projects. It integrates seamlessly with Claude Desktop to provide AI-powered project management, development workflows, and team collaboration.

## Features

Atlas provides a complete startup development platform with:

- **🚀 Agile Project Management** - 30 tools for sprints, stories, epics with Phase 2 analytics
- **📋 Kanban Boards** - Visual task management with WIP limits and flow metrics
- **🧪 Test-Driven Development** - Enforced TDD workflow with coverage tracking
- **📊 Web Dashboard** - Real-time project visualization with analytics and charts
- **🔍 Smart Search** - RAG-powered documentation and code search
- **📝 Architecture Decisions** - ADR management with templates and tracking
- **💾 Data Management** - Structured data storage with validation
- **🤖 Process Automation** - Workflow automation and human-in-the-loop approvals
- **📚 Documentation Generation** - Automated docs with multiple formats
- **🧠 Memory Management** - Project knowledge persistence and retrieval
- **🛠️ Development Tools** - Code quality, testing, and performance monitoring
- **📦 Product Requirements** - PRD management with validation
- **🔄 Developer Workflow** - Git best practices and code review
- **🏢 Workspace Management** - Multi-project support

## Installation

### Prerequisites

- Node.js 18 or higher
- npm 7 or higher
- Claude Desktop (for MCP integration)

### Install from npm

```bash
npm install -g @boundless-oss/atlas
```

### Build from Source

```bash
git clone https://github.com/boundless-oss/atlas.git
cd atlas
npm install
npm run build
npm link
```

## Quick Start

### 1. Configure Claude Desktop

Add Atlas to your Claude Desktop configuration file:

**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`  
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

```json
{
  "mcpServers": {
    "atlas": {
      "command": "atlas",
      "args": [],
      "env": {
        "ATLAS_DASHBOARD_ENABLED": "true"
      }
    }
  }
}
```

### 2. Start Using Atlas

1. Restart Claude Desktop
2. Atlas will start automatically when Claude launches
3. The web dashboard will open at `http://localhost:3001` (or next available port)

### 3. Try These Commands in Claude

- "Check my project status"
- "Create a new sprint called 'MVP Development'"
- "Add a story for user authentication"
- "Show me the current sprint progress"
- "Generate a sprint report"
- "What's my team velocity?"

## Web Dashboard

Atlas includes a comprehensive web dashboard that automatically starts with the MCP server:

- **Overview**: Project metrics, velocity charts, and sprint progress
- **Agile Board**: Kanban board with drag-and-drop story management
- **Analytics**: Team velocity, cycle time, cross-sprint analytics
- **Epic Management**: Epic progress tracking, burndown charts, and timeline views
- **Security**: Approval workflows and audit trails
- **Metrics**: Performance monitoring and quality metrics

The dashboard runs on port 3001 by default (or the next available port).

## Available Modules & Tools

Atlas provides **178 tools** across **14 active modules**:

1. **Agile Management** (30 tools) - Complete agile workflow with Phase 2 analytics
2. **Kanban** (12 tools) - Visual task boards with flow metrics
3. **ADR Management** (11 tools) - Architecture decision records
4. **Memory Management** (8 tools) - Project knowledge and context
5. **Development** (13 tools) - TDD, code quality, and testing
6. **Workspace** (7 tools) - Multi-project management
7. **Local AI** (5 tools) - Local model integration
8. **Documentation** (11 tools) - Auto-generated documentation
9. **Product Requirements** (8 tools) - PRD management
10. **RAG Retrieval** (7 tools) - Intelligent search
11. **Process Automation** (22 tools) - Workflow automation
12. **Developer Workflow** (8 tools) - Git and code review
13. **Data Management** (8 tools) - Structured data storage
14. **Web Dashboard** - Real-time project visualization

For a complete list of all tools, see [docs/MODULES_AND_TOOLS.md](docs/MODULES_AND_TOOLS.md).

## Project Structure

```
my-project/
├── .atlas/              # Atlas data and configuration
│   ├── atlas.db        # SQLite database
│   ├── config.json     # Project configuration
│   └── data/           # Module-specific data
├── src/                # Your source code
├── tests/              # Your test files
└── docs/               # Your documentation
```

## Configuration

Atlas can be configured through:

1. **Project Config**: `.atlas/config.json` in your project
2. **User Config**: `~/.atlas/config.json` for global settings
3. **Environment Variables**: Override any setting

Example configuration:

```json
{
  "project": {
    "name": "My Startup",
    "methodology": "agile"
  },
  "dashboard": {
    "enabled": true,
    "port": 3001
  },
  "modules": {
    "enabledModules": ["agile-management", "kanban", "development"]
  }
}
```

## Using with Claude

Atlas integrates seamlessly with Claude through MCP. Once configured, you can:

- **Project Management**: "Create epics and stories for our MVP"
- **Sprint Planning**: "Start a new 2-week sprint with our backlog items"
- **Progress Tracking**: "Show me burndown chart for current sprint"
- **Team Analytics**: "What's our average cycle time?"
- **Architecture**: "Create an ADR for our database choice"
- **Documentation**: "Generate API documentation"
- **Search**: "Find all code related to authentication"

## Development Workflow

Atlas enforces best practices:

1. **Test-Driven Development**: Write tests first, then implementation
2. **Architecture Decisions**: Document important choices with ADRs
3. **Sprint-Based Work**: Organize work into manageable sprints
4. **Continuous Tracking**: Monitor velocity and cycle time
5. **Knowledge Capture**: Automatically save project context

## Advanced Features

- **12-Factor Architecture**: Enterprise-grade MCP implementation
- **Phase 2 Analytics**: Advanced metrics and cross-sprint analysis
- **Epic Management**: Hierarchical planning with progress tracking
- **Human-in-the-Loop**: Approval workflows for critical operations
- **Multi-Project**: Manage multiple projects from one instance
- **Extensible**: Add custom modules and tools

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

## Documentation

- [Getting Started Guide](docs/getting-started/installation.md)
- [Module & Tools Reference](docs/MODULES_AND_TOOLS.md)
- [User Guide](docs/user-guide/concepts.md)
- [API Reference](docs/reference/api/README.md)
- [Developer Guide](docs/developer-guide/module-dev.md)

## Support

- [GitHub Issues](https://github.com/boundless-oss/atlas/issues)
- [Documentation](docs/README.md)
- [Changelog](CHANGELOG.md)

## License

MIT © [Boundless OSS](https://github.com/boundless-oss)

---

Built with ❤️ for startup founders who ship fast and test first.