Documentation Workflow MVP

An AI-powered documentation management system with hierarchical context management and session continuity.

GitHub

Documentation Workflow MVP

A sophisticated documentation management system with AI-powered assistance through Model Context Protocol (MCP) integration. This system provides hierarchical context management, session continuity, and comprehensive documentation lifecycle support.

🌟 Features

Document Management

  • Full Lifecycle Support: Create, update, delete, and publish documents
  • Rich Metadata: Frontmatter with timestamps, status tracking, and categorization
  • Location-based Organization: Separate areas for drafts, documentation, updates, and plans
  • Advanced Search: Content and metadata search with filtering capabilities

Context Management System

  • Hierarchical Architecture: 6-level context hierarchy from global to session
  • Dynamic Loading: Context-aware operations with automatic state management
  • Persistent Storage: JSON-based context preservation across sessions

Session Continuity

  • State Preservation: Save and restore work sessions across token limits
  • Automatic Recovery: Resume work exactly where you left off
  • Plan Integration: Work plans serve as restoration anchors
  • Progress Tracking: Maintain task state and active documents

AI Integration

  • MCP Server: Claude Desktop integration for AI-assisted documentation
  • 20+ Specialized Tools: Purpose-built commands for documentation workflows
  • Intelligent Analysis: Documentation completeness and structure assessment
  • Context-Aware Operations: AI understands project structure and conventions

🚀 Quick Start

Prerequisites

  • Node.js 18+ and npm
  • Docker and Docker Compose (optional)
  • Claude Desktop (for AI features)
  • WSL (if running on Windows)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/documentation-workflow-mvp.git
cd documentation-workflow-mvp
  1. Configure environment (optional):
# No configuration required! System works with defaults
# Only needed if you want custom settings:
cp .env.example .env
  1. Install MCP server dependencies:
cd mcp-server
npm install
npm run build
  1. Configure Claude Desktop:
{
  "mcpServers": {
    "documentation-workflow": {
      "command": "node",
      "args": ["/path/to/documentation-workflow-mvp/mcp-server/dist/index.js"],
      "cwd": "/path/to/documentation-workflow-mvp"
    }
  }
}
  1. Start the services (optional):
docker-compose up -d

⚙️ Configuration

The project uses environment variables for configuration. See .env.example for all available options:

  • Workspace path - Single directory for all documentation data
  • Logging levels - Control verbosity
  • Feature flags - Enable/disable features
  • Performance settings - Tune for your system

Key settings:

NODE_ENV=development              # Environment mode
LOG_LEVEL=info                   # Logging verbosity
WORKSPACE_PATH=~/DocumentWorkflow # Document workspace location

The workspace contains:

WORKSPACE_PATH/
├── projects/     # All documentation projects
└── contexts/     # Context and session data

📖 Documentation

For Users

For AI Assistants

Role-Specific AI Guides

Technical Reference

🛠️ Usage Examples

Initialize a New Project

# Through Claude Desktop
> "Initialize a new documentation project called 'my-api-docs'"

Create Documentation

# Create a new guide
> "Create a guide about authentication in the my-api-docs project"

# Create a reference document
> "Create a reference document for the User API endpoints"

Manage Sessions

# Save current work session
> "Save my current session - working on authentication docs"

# Resume previous session
> "Load my session for the my-api-docs project"

Analyze Documentation

# Check project completeness
> "Analyze the documentation coverage for my-api-docs"

# View project structure
> "Show me the structure of my-api-docs in tree format"

🏗️ Architecture

┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│  Claude Desktop │────▶│    MCP Server    │────▶│   File System   │
│   (AI Agent)    │     │  (20+ Tools)     │     │  (Documents)    │
└─────────────────┘     └──────────────────┘     └─────────────────┘
                               │
                               ▼
                        ┌──────────────────┐
                        │ Context System   │
                        │ (6 Hierarchies)  │
                        └──────────────────┘

🧪 Testing

cd mcp-server
npm test                    # Run all tests
npm test -- tests/simple   # Run simplified tests

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

📞 Support

Made with ❤️ for the documentation community

Servidores relacionados