SimplePlan


NameSimplePlan JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://github.com/Sunset-Code-Collaborative/SimplePlan
SummaryAI-native project management with MCP integration for universal AI access
upload_time2025-07-13 18:01:17
maintainerNone
docs_urlNone
authorSunset Code Collaborative, LLC
requires_python<3.14,>=3.10
licenseMIT
keywords project-management ai mcp planning workflow
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # SimplePlan

๐ŸŽฏ **The First AI-Native Project Management Tool with Universal AI Access**

[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://python.org)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-green.svg)](https://modelcontextprotocol.io/)
[![Tests](https://github.com/bjornjohnson/SimplePlan/actions/workflows/test.yml/badge.svg)](https://github.com/bjornjohnson/SimplePlan/actions/workflows/test.yml)
[![Publish](https://github.com/bjornjohnson/SimplePlan/actions/workflows/publish.yml/badge.svg)](https://github.com/bjornjohnson/SimplePlan/actions/workflows/publish.yml)

## ๐Ÿš€ What is SimplePlan?

SimplePlan revolutionizes project management by enabling **direct AI control** over project plans. Unlike traditional tools where AI can only suggest actions, SimplePlan's Model Context Protocol (MCP) integration allows AI systems to:

- **Create and manage** project plans autonomously
- **Track progress** in real-time  
- **Add and complete** project steps with dependency validation
- **Optimize workflows** based on project status
- **Coordinate teams** through intelligent step assignment

## โœจ Key Features

### ๐Ÿง  **AI-Native Design**
- **7 MCP Tools** for complete project control via AI
- **Universal AI Access** through Claude Desktop and other MCP hosts
- **Real-time Collaboration** between humans and AI systems

### ๐Ÿ“‹ **Comprehensive Project Management**
- **Dependency Validation** ensures logical project flow
- **Progress Tracking** with completion percentages
- **Step Management** with types, assignments, and timestamps
- **Project Validation** catches errors before they cause problems

### ๐Ÿ”Œ **Modern Integration**
- **FastMCP Framework** for efficient AI communication
- **CLI Interface** for manual project management
- **JSON Storage** for portable, version-controllable plans
- **Rich Terminal UI** for beautiful command-line experience

## ๐Ÿ› ๏ธ MCP Tools Available

1. **`create_project_plan`** - Start new projects with AI
2. **`get_project_status`** - Check progress and completion
3. **`add_project_step`** - Add work items with dependencies
4. **`complete_step`** - Mark work done with validation
5. **`get_next_steps`** - Find available work (no blockers)
6. **`list_all_steps`** - Show complete project overview
7. **`validate_project_plan`** - Check for errors and issues

## ๐Ÿš€ Quick Start

### Installation
```bash
git clone https://github.com/bjornjohnson/SimplePlan.git
cd SimplePlan
poetry install
```

### CLI Usage
```bash
# Create a new project
poetry run simpleplan create "My Web App" "Build a React todo application"

# Add project steps
poetry run simpleplan add "Set up development environment" --type setup
poetry run simpleplan add "Create React components" --type development --depends STEP-001

# Track progress
poetry run simpleplan status
poetry run simpleplan next

# Complete work
poetry run simpleplan complete STEP-001
```

### MCP Integration (AI Access)
1. **Configure Claude Desktop** with SimplePlan MCP server
2. **Ask AI** to manage your projects directly
3. **Watch AI** create, track, and optimize your project plans autonomously

See [MCP_INTEGRATION.md](MCP_INTEGRATION.md) for complete setup instructions.

## ๐Ÿ“š Documentation

- **[MCP Integration Guide](MCP_INTEGRATION.md)** - Complete setup and usage
- **[Usage Examples](MCP_USAGE_EXAMPLES.md)** - Real-world AI scenarios  
- **[Intellectual Property Guide](INTELLECTUAL_PROPERTY.md)** - Ownership and protection

## ๐ŸŽฏ Why SimplePlan?

### **Before SimplePlan:**
- AI: "You should run `npm install react`"
- Human: *manually runs command*
- AI: "Now create components..."
- Human: *manually executes each suggestion*

### **After SimplePlan:**
- AI: *directly creates project plan with React setup*
- AI: *adds development steps with proper dependencies*
- AI: *tracks progress as human completes work*
- AI: *suggests optimizations and next priorities*

**Result:** Seamless human-AI collaboration instead of suggestion-based workflows.

## ๐Ÿ—๏ธ Architecture

```
Claude Desktop (Host) 
    โ†“ JSON-RPC 2.0 via stdio
SimplePlan MCP Server (FastMCP)
    โ†“ Function calls
SimplePlan Core (project_plan_io.py)
    โ†“ File operations  
Project Plan JSON Files
```

## ๐Ÿงช Development

### Setup
```bash
poetry install
poetry shell  # Activate virtual environment

# Run tests
poetry run pytest

# Development commands
poetry run black .         # Format code
poetry run ruff .          # Lint code  
poetry run isort .         # Sort imports
poetry run mypy .          # Type checking
```

### Project Status
- **Phase 1 Complete**: Full CLI functionality with comprehensive tests
- **Phase 2 Complete**: MCP integration with 7 AI tools
- **Current Status**: 100% complete, production-ready

## ๐Ÿ“„ License & Copyright

**Copyright ยฉ 2025 Sunset Code Collaborative, LLC. All rights reserved.**

Licensed under the [MIT License](LICENSE). This means:
- โœ… **Free to use** for any purpose
- โœ… **Free to modify** and distribute
- โœ… **Commercial use** permitted
- โš ๏ธ **Attribution required** - must include copyright notice
- โš ๏ธ **No warranty** - use at your own risk

## ๐Ÿค Contributing

SimplePlan is open to contributions! Please:
1. **Fork** the repository
2. **Create** a feature branch
3. **Add** tests for new functionality
4. **Submit** a pull request with clear description

All contributors must respect the copyright and licensing terms.

## ๐Ÿ“ž Contact

**Sunset Code Collaborative, LLC** - Creator & Maintainer
- Contact: Bjorn Johnson, Member
- GitHub: [@bjornjohnson](https://github.com/bjornjohnson)
- Email: bjorn@sunsetcodecollaborative.com

## ๐ŸŽ‰ Acknowledgments

- **FastMCP** - Excellent MCP framework for Python
- **Claude Desktop** - First-class MCP host implementation
- **Model Context Protocol** - Revolutionary AI integration standard

---

**๐Ÿ† SimplePlan: Pioneering the future of AI-human project collaboration since 2025**

*Built with โค๏ธ and cutting-edge AI integration*

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Sunset-Code-Collaborative/SimplePlan",
    "name": "SimplePlan",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": null,
    "keywords": "project-management, ai, mcp, planning, workflow",
    "author": "Sunset Code Collaborative, LLC",
    "author_email": "bjorn@sunsetcodecollaborative.com",
    "download_url": "https://files.pythonhosted.org/packages/c0/78/576bf5302b285b7382f2566edf336e42188ab8340022650776e66ce0c2e0/simpleplan-1.0.3.tar.gz",
    "platform": null,
    "description": "# SimplePlan\n\n\ud83c\udfaf **The First AI-Native Project Management Tool with Universal AI Access**\n\n[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://python.org)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-green.svg)](https://modelcontextprotocol.io/)\n[![Tests](https://github.com/bjornjohnson/SimplePlan/actions/workflows/test.yml/badge.svg)](https://github.com/bjornjohnson/SimplePlan/actions/workflows/test.yml)\n[![Publish](https://github.com/bjornjohnson/SimplePlan/actions/workflows/publish.yml/badge.svg)](https://github.com/bjornjohnson/SimplePlan/actions/workflows/publish.yml)\n\n## \ud83d\ude80 What is SimplePlan?\n\nSimplePlan revolutionizes project management by enabling **direct AI control** over project plans. Unlike traditional tools where AI can only suggest actions, SimplePlan's Model Context Protocol (MCP) integration allows AI systems to:\n\n- **Create and manage** project plans autonomously\n- **Track progress** in real-time  \n- **Add and complete** project steps with dependency validation\n- **Optimize workflows** based on project status\n- **Coordinate teams** through intelligent step assignment\n\n## \u2728 Key Features\n\n### \ud83e\udde0 **AI-Native Design**\n- **7 MCP Tools** for complete project control via AI\n- **Universal AI Access** through Claude Desktop and other MCP hosts\n- **Real-time Collaboration** between humans and AI systems\n\n### \ud83d\udccb **Comprehensive Project Management**\n- **Dependency Validation** ensures logical project flow\n- **Progress Tracking** with completion percentages\n- **Step Management** with types, assignments, and timestamps\n- **Project Validation** catches errors before they cause problems\n\n### \ud83d\udd0c **Modern Integration**\n- **FastMCP Framework** for efficient AI communication\n- **CLI Interface** for manual project management\n- **JSON Storage** for portable, version-controllable plans\n- **Rich Terminal UI** for beautiful command-line experience\n\n## \ud83d\udee0\ufe0f MCP Tools Available\n\n1. **`create_project_plan`** - Start new projects with AI\n2. **`get_project_status`** - Check progress and completion\n3. **`add_project_step`** - Add work items with dependencies\n4. **`complete_step`** - Mark work done with validation\n5. **`get_next_steps`** - Find available work (no blockers)\n6. **`list_all_steps`** - Show complete project overview\n7. **`validate_project_plan`** - Check for errors and issues\n\n## \ud83d\ude80 Quick Start\n\n### Installation\n```bash\ngit clone https://github.com/bjornjohnson/SimplePlan.git\ncd SimplePlan\npoetry install\n```\n\n### CLI Usage\n```bash\n# Create a new project\npoetry run simpleplan create \"My Web App\" \"Build a React todo application\"\n\n# Add project steps\npoetry run simpleplan add \"Set up development environment\" --type setup\npoetry run simpleplan add \"Create React components\" --type development --depends STEP-001\n\n# Track progress\npoetry run simpleplan status\npoetry run simpleplan next\n\n# Complete work\npoetry run simpleplan complete STEP-001\n```\n\n### MCP Integration (AI Access)\n1. **Configure Claude Desktop** with SimplePlan MCP server\n2. **Ask AI** to manage your projects directly\n3. **Watch AI** create, track, and optimize your project plans autonomously\n\nSee [MCP_INTEGRATION.md](MCP_INTEGRATION.md) for complete setup instructions.\n\n## \ud83d\udcda Documentation\n\n- **[MCP Integration Guide](MCP_INTEGRATION.md)** - Complete setup and usage\n- **[Usage Examples](MCP_USAGE_EXAMPLES.md)** - Real-world AI scenarios  \n- **[Intellectual Property Guide](INTELLECTUAL_PROPERTY.md)** - Ownership and protection\n\n## \ud83c\udfaf Why SimplePlan?\n\n### **Before SimplePlan:**\n- AI: \"You should run `npm install react`\"\n- Human: *manually runs command*\n- AI: \"Now create components...\"\n- Human: *manually executes each suggestion*\n\n### **After SimplePlan:**\n- AI: *directly creates project plan with React setup*\n- AI: *adds development steps with proper dependencies*\n- AI: *tracks progress as human completes work*\n- AI: *suggests optimizations and next priorities*\n\n**Result:** Seamless human-AI collaboration instead of suggestion-based workflows.\n\n## \ud83c\udfd7\ufe0f Architecture\n\n```\nClaude Desktop (Host) \n    \u2193 JSON-RPC 2.0 via stdio\nSimplePlan MCP Server (FastMCP)\n    \u2193 Function calls\nSimplePlan Core (project_plan_io.py)\n    \u2193 File operations  \nProject Plan JSON Files\n```\n\n## \ud83e\uddea Development\n\n### Setup\n```bash\npoetry install\npoetry shell  # Activate virtual environment\n\n# Run tests\npoetry run pytest\n\n# Development commands\npoetry run black .         # Format code\npoetry run ruff .          # Lint code  \npoetry run isort .         # Sort imports\npoetry run mypy .          # Type checking\n```\n\n### Project Status\n- **Phase 1 Complete**: Full CLI functionality with comprehensive tests\n- **Phase 2 Complete**: MCP integration with 7 AI tools\n- **Current Status**: 100% complete, production-ready\n\n## \ud83d\udcc4 License & Copyright\n\n**Copyright \u00a9 2025 Sunset Code Collaborative, LLC. All rights reserved.**\n\nLicensed under the [MIT License](LICENSE). This means:\n- \u2705 **Free to use** for any purpose\n- \u2705 **Free to modify** and distribute\n- \u2705 **Commercial use** permitted\n- \u26a0\ufe0f **Attribution required** - must include copyright notice\n- \u26a0\ufe0f **No warranty** - use at your own risk\n\n## \ud83e\udd1d Contributing\n\nSimplePlan is open to contributions! Please:\n1. **Fork** the repository\n2. **Create** a feature branch\n3. **Add** tests for new functionality\n4. **Submit** a pull request with clear description\n\nAll contributors must respect the copyright and licensing terms.\n\n## \ud83d\udcde Contact\n\n**Sunset Code Collaborative, LLC** - Creator & Maintainer\n- Contact: Bjorn Johnson, Member\n- GitHub: [@bjornjohnson](https://github.com/bjornjohnson)\n- Email: bjorn@sunsetcodecollaborative.com\n\n## \ud83c\udf89 Acknowledgments\n\n- **FastMCP** - Excellent MCP framework for Python\n- **Claude Desktop** - First-class MCP host implementation\n- **Model Context Protocol** - Revolutionary AI integration standard\n\n---\n\n**\ud83c\udfc6 SimplePlan: Pioneering the future of AI-human project collaboration since 2025**\n\n*Built with \u2764\ufe0f and cutting-edge AI integration*\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "AI-native project management with MCP integration for universal AI access",
    "version": "1.0.3",
    "project_urls": {
        "Documentation": "https://github.com/Sunset-Code-Collaborative/SimplePlan/blob/main/README.md",
        "Homepage": "https://github.com/Sunset-Code-Collaborative/SimplePlan",
        "Repository": "https://github.com/Sunset-Code-Collaborative/SimplePlan"
    },
    "split_keywords": [
        "project-management",
        " ai",
        " mcp",
        " planning",
        " workflow"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "040c0b7a70053ff7f7dd0621251440a0b003aa15bd00bcd4e8c8d531d31de369",
                "md5": "9fe679149880ec6b8adcb38901ec12d8",
                "sha256": "bd37cfaf35a2485a9e3da18c71c36424253fbfb84d8358af67597fcab0de6762"
            },
            "downloads": -1,
            "filename": "simpleplan-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9fe679149880ec6b8adcb38901ec12d8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 13359,
            "upload_time": "2025-07-13T18:01:15",
            "upload_time_iso_8601": "2025-07-13T18:01:15.936694Z",
            "url": "https://files.pythonhosted.org/packages/04/0c/0b7a70053ff7f7dd0621251440a0b003aa15bd00bcd4e8c8d531d31de369/simpleplan-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c078576bf5302b285b7382f2566edf336e42188ab8340022650776e66ce0c2e0",
                "md5": "2abc0b91b8597c84f9a84a025d01ff7a",
                "sha256": "4c52e3800fa3f823141814120118cb3b4832f9179239554049228812f1526fd5"
            },
            "downloads": -1,
            "filename": "simpleplan-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2abc0b91b8597c84f9a84a025d01ff7a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.10",
            "size": 13005,
            "upload_time": "2025-07-13T18:01:17",
            "upload_time_iso_8601": "2025-07-13T18:01:17.403851Z",
            "url": "https://files.pythonhosted.org/packages/c0/78/576bf5302b285b7382f2566edf336e42188ab8340022650776e66ce0c2e0/simpleplan-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-13 18:01:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Sunset-Code-Collaborative",
    "github_project": "SimplePlan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "simpleplan"
}
        
Elapsed time: 2.04028s