docs: add scope summary document
Created SCOPE.md to clearly document project scope changes and provide a single source of truth for what's in/out of scope. Contents: - Current scope (US1-US3 with tool lists) - Removed scope (US4-US5 with rationale) - Impact summary (before/after comparison) - Implementation status table - Next steps roadmap Benefits: - Clear reference for scope discussions - Tracks removed features for potential future work - Documents decision rationale - Provides implementation progress snapshot File: specs/001-obsidian-mcp-bundle/SCOPE.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
115
specs/001-obsidian-mcp-bundle/SCOPE.md
Normal file
115
specs/001-obsidian-mcp-bundle/SCOPE.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# Project Scope: Obsidian MCP Bundle
|
||||
|
||||
**Last Updated**: 2026-03-22
|
||||
**Status**: Active Development
|
||||
|
||||
## Current Scope (3 User Stories)
|
||||
|
||||
### ✅ User Story 1 - File Operations (P1) - COMPLETE
|
||||
**Status**: Implemented (9 tools, 17 tasks complete)
|
||||
|
||||
Tools:
|
||||
- obsidian_create_note
|
||||
- obsidian_read_note
|
||||
- obsidian_append_to_note
|
||||
- obsidian_prepend_to_note
|
||||
- obsidian_delete_note
|
||||
- obsidian_move_note
|
||||
- obsidian_rename_note
|
||||
- obsidian_duplicate_note
|
||||
- obsidian_open_note
|
||||
|
||||
### ✅ User Story 2 - Search & Discovery (P2) - COMPLETE
|
||||
**Status**: Implemented (11 tools, 18 tasks complete)
|
||||
|
||||
Tools:
|
||||
- obsidian_search
|
||||
- obsidian_list_backlinks
|
||||
- obsidian_list_links
|
||||
- obsidian_list_unresolved_links
|
||||
- obsidian_list_tags
|
||||
- obsidian_list_tag_counts
|
||||
- obsidian_list_aliases
|
||||
- obsidian_list_alias_counts
|
||||
- obsidian_list_properties
|
||||
- obsidian_list_property_counts
|
||||
- obsidian_get_property_values
|
||||
|
||||
### 🚧 User Story 3 - Task & Property Management (P3) - PENDING
|
||||
**Status**: Not started (0/18 tasks complete)
|
||||
|
||||
Planned Tools:
|
||||
- Task operations (list, toggle, create, mark done/todo)
|
||||
- Property management (read, set, remove)
|
||||
- Frontmatter manipulation
|
||||
|
||||
## Removed Scope
|
||||
|
||||
### ❌ User Story 4 - Vault Navigation (P4) - REMOVED
|
||||
**Reason**: Non-essential utility features; can be added later if needed
|
||||
|
||||
Removed Tools (15 total):
|
||||
- File/folder listing (obsidian_list_files, obsidian_list_folders)
|
||||
- Vault statistics (obsidian_get_vault_info, obsidian_get_folder_info)
|
||||
- Navigation helpers (obsidian_list_recents, obsidian_get_outline)
|
||||
- Random note features (obsidian_random_note, obsidian_random_read)
|
||||
- System info (obsidian_get_version, obsidian_list_vaults)
|
||||
|
||||
### ❌ User Story 5 - Advanced Features (P5) - REMOVED
|
||||
**Reason**: Power-user features; reduces complexity and maintenance burden
|
||||
|
||||
Removed Tools (45 total):
|
||||
- **Daily Notes** (6 tools): open_daily_note, daily_append, daily_prepend, etc.
|
||||
- **Templates** (3 tools): list_templates, read_template, insert_template
|
||||
- **Bookmarks** (5 tools): create_bookmark, list_bookmarks, bookmark_file, etc.
|
||||
- **Plugins** (6 tools): list_plugins, enable_plugin, disable_plugin, etc.
|
||||
- **Themes** (6 tools): list_themes, get_active_theme, set_theme, etc.
|
||||
- **File History** (12 tools): list_versions, restore_version, sync operations
|
||||
- **Bases & Commands** (7 tools): list_bases, query_base, execute_command, etc.
|
||||
|
||||
## Impact Summary
|
||||
|
||||
### Before Removal
|
||||
- **5 User Stories** (US1-US5)
|
||||
- **95 Total Tools**
|
||||
- **165 Total Tasks**
|
||||
- **19 Functional Requirements** (FR-001 to FR-025, with gaps)
|
||||
|
||||
### After Removal
|
||||
- **3 User Stories** (US1-US3)
|
||||
- **20 Total Tools** (20 implemented, 0 planned for US3)
|
||||
- **98 Total Tasks** (67 tasks removed, 40% reduction)
|
||||
- **19 Functional Requirements** (FR-001 to FR-019, renumbered sequentially)
|
||||
|
||||
### Benefits
|
||||
- ✅ Clearer MVP scope (file ops + search + tasks)
|
||||
- ✅ Faster time to production-ready bundle
|
||||
- ✅ Reduced testing and maintenance surface area
|
||||
- ✅ Simpler documentation and user onboarding
|
||||
- ✅ Focus on 80% use cases rather than comprehensive coverage
|
||||
|
||||
### Future Expansion
|
||||
If needed, US4 and US5 can be added later as separate releases:
|
||||
- **v2.0**: Add US4 (Vault Navigation) - 18 additional tasks
|
||||
- **v3.0**: Add US5 (Advanced Features) - 49 additional tasks
|
||||
|
||||
## Current Implementation Status
|
||||
|
||||
| Phase | Description | Status | Tasks |
|
||||
|-------|-------------|--------|-------|
|
||||
| Phase 1 | Setup | ✅ Complete | 12/12 |
|
||||
| Phase 2 | Foundational | ✅ Complete | 19/19 |
|
||||
| Phase 3 | User Story 1 (File Ops) | ✅ Complete | 17/17 |
|
||||
| Phase 4 | User Story 2 (Search) | ✅ Complete | 18/18 |
|
||||
| Phase 5 | User Story 3 (Tasks) | 🚧 Pending | 0/18 |
|
||||
| Phase 6 | Polish | 🚧 Partial | 4/14 |
|
||||
|
||||
**Total Progress**: 70/98 tasks complete (71.4%)
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ User Story 1 implementation - DONE
|
||||
2. ✅ User Story 2 implementation - DONE
|
||||
3. 🎯 User Story 3 implementation - NEXT
|
||||
4. Final polish and documentation
|
||||
5. Production release (v1.0)
|
||||
Reference in New Issue
Block a user