Version: 7.2.0 Last Updated: December 21, 2025
Complete documentation for the HacknPlan Model Context Protocol (MCP) server.
Start here if you're new to the HacknPlan MCP server.
| Guide | Description |
|---|---|
| Installation | Install and build the server |
| Configuration | Set up API keys and environment |
| Quick Start | Your first API calls and workflows |
Estimated time: 15 minutes to full setup
Essential operations for projects, boards, and work items.
| Guide | Description |
|---|---|
| Projects | Create and manage projects |
| Boards & Sprints | Sprint planning and tracking |
| Guide | Description |
|---|---|
| Work Items | Tasks, bugs, features - complete CRUD |
| Comments | Add and manage comments (markdown support) |
| Milestones | Track major deliverables |
| Design Elements | Game design documents (GDD) |
Major features and capabilities.
| Guide | Description |
|---|---|
| Deletion Safety | Recovery system, 2-step confirmation, persistent cache |
| Automatic Time Tracking | Zero-effort time logging with start/complete workflow |
| Slim Mode | Context optimization (~75% token reduction) |
| Array-Based API | Unified batch operations (1-100 items) |
| Tool Search | Dynamic tool discovery (85% context savings) |
Power-user features and optimizations.
| Guide | Description |
|---|---|
| Workflow Shortcuts | start_task, complete_task, create_subtask |
| Batch Operations | Search, queries, sprint analytics, dependencies |
| Guide | Description |
|---|---|
| Metadata & Configuration | Stages, categories, tags, users, importance levels |
| Caching | Performance optimization, cache management |
Practical guides and best practices.
| Guide | Description |
|---|---|
| Common Patterns | Real-world recipes and workflows |
| Error Handling | Error types, retry logic, troubleshooting |
| Deprecation Guide | Parameter deprecation warnings and migration |
| Best Practices | Optimization tips and recommendations |
I want to...
- Set up the server → Installation → Configuration
- Make my first API call → Quick Start
- Create and manage tasks → Work Items
- Plan sprints → Boards & Sprints
- Track time automatically → Automatic Time Tracking
- Recover deleted items → Deletion Safety
- Reduce token usage → Slim Mode + Tool Search
- Batch create/update items → Array-Based API
- Understand errors → Error Handling
- Optimize performance → Caching + Best Practices
Beginner (Start here):
Intermediate (Core features):
Advanced (Optimization):
- Time Management: Automatic Time Tracking, Workflow Shortcuts
- Task Management: Work Items, Boards & Sprints, Milestones
- Collaboration: Comments, Design Elements
- Safety: Deletion Safety, Error Handling
- Performance: Slim Mode, Caching, Tool Search
- Batch Operations: Array-Based API, Batch Operations
- Configuration: Metadata & Config, Configuration
Projects & Organization
- Projects - Project CRUD and metrics
- Boards & Sprints - Sprint management
- Milestones - Major deliverables
Tasks & Work Items
- Work Items - Complete CRUD reference
- Comments - Markdown comments
- Workflow Shortcuts - start_task, complete_task
- Batch Operations - Search and queries
Time Tracking
- Automatic Time Tracking - Zero-effort logging
- Workflow Shortcuts - start_task, complete_task
- Common Patterns - Time tracking workflows
Safety & Recovery
- Deletion Safety - Recovery system
- Error Handling - Error types and patterns
- Best Practices - Prevention tips
Performance & Optimization
- Slim Mode - Context optimization
- Tool Search - Dynamic tool loading
- Caching - Cache management
- Best Practices - Performance tips
- Main README: ../README.md - Project overview and quick setup
- API Reference: ../API-REFERENCE.md - Complete technical reference (2,912 lines)
- Claude.ai Guide: ../CLAUDE.md - AI assistant integration guide
- Deletion Safety: ../BACKLOG-SAFETY-GUIDE.md - Comprehensive safety guide
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- HacknPlan API: Official API Docs
Most Popular:
- Quick Start - Get running in 5 minutes
- Work Items - Task management reference
- Automatic Time Tracking - Effortless time logging
- Common Patterns - Real-world recipes
- Deletion Safety - Recover deleted items
Essential Setup:
Power Features:
- Slim Mode - Save 75% tokens
- Tool Search - Save 85% on tool loading
- Array-Based API - Batch 100 operations
- Workflow Shortcuts - Combine operations
Need Help?
- Start with Quick Start Guide
- Check Common Patterns for recipes
- Review Error Handling if stuck
- See Best Practices for optimization
Last Updated: December 21, 2025 | Version: 7.2.0