From f66718122afe788a19fce61fbb11f9df92db4a9a Mon Sep 17 00:00:00 2001 From: yusyus Date: Sun, 19 Oct 2025 15:23:58 +0300 Subject: [PATCH] Add project planning and roadmap documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Planning Structure:** - TODO.md - Sprint planning and current tasks - ROADMAP.md - Long-term vision and milestones - .github/ISSUE_TEMPLATE/ - Issue templates for features and MCP tools **TODO.md:** - 5 phases: Core (done), Enhancement, Advanced, Docs, Integrations - Current sprint tasks clearly defined - Progress tracking with checkboxes **ROADMAP.md:** - Vision and milestones - v1.0 (done), v1.1 (in progress), v1.2-3.0 (planned) - Feature ideas categorized by priority - Metrics and goals - Release schedule **Issue Templates:** - feature_request.md - General features - mcp_tool.md - New MCP tools specifically Next: Fix tests, test MCP with Claude Code, document setup 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- .github/ISSUE_TEMPLATE/feature_request.md | 36 +++++ .github/ISSUE_TEMPLATE/mcp_tool.md | 42 +++++ ROADMAP.md | 189 ++++++++++++++++++++++ TODO.md | 53 ++++++ 4 files changed, 320 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/mcp_tool.md create mode 100644 ROADMAP.md create mode 100644 TODO.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..cdc96e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,36 @@ +--- +name: Feature Request +about: Suggest a new feature for Skill Seeker or MCP server +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +## Feature Description + + +## Use Case + + +## Proposed Solution + + +## Component +- [ ] CLI Tool +- [ ] MCP Server +- [ ] Configuration +- [ ] Documentation +- [ ] Tests + +## Examples + + +```bash +# Example usage +``` + +## Alternatives Considered + + +## Additional Context + diff --git a/.github/ISSUE_TEMPLATE/mcp_tool.md b/.github/ISSUE_TEMPLATE/mcp_tool.md new file mode 100644 index 0000000..d4f1464 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/mcp_tool.md @@ -0,0 +1,42 @@ +--- +name: MCP Tool Request +about: Suggest a new tool for the MCP server +title: '[MCP] Add tool: ' +labels: mcp, enhancement +assignees: '' +--- + +## Tool Name + + +## Tool Description + + +## Input Parameters +```json +{ + "param1": { + "type": "string", + "description": "...", + "required": true + } +} +``` + +## Expected Output + + +## Use Case Example + +``` +User: "Auto-detect selectors for https://docs.example.com" +Tool: Analyzes page structure and suggests optimal selectors +``` + +## CLI Integration + +- [ ] Wraps existing CLI tool: `cli/tool_name.py` +- [ ] New functionality + +## Implementation Notes + diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..a9b76c4 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,189 @@ +# Skill Seeker Development Roadmap + +## Vision +Transform Skill Seeker into the easiest way to create Claude AI skills from any documentation website, with both CLI and MCP interfaces. + +--- + +## 🎯 Milestones + +### ✅ v1.0 - Core CLI Tool (COMPLETED) +- [x] Documentation scraping with BFS +- [x] Smart categorization +- [x] Language detection +- [x] Pattern extraction +- [x] 6 preset configurations +- [x] Comprehensive test suite (71 tests) + +### 🚧 v1.1 - MCP Integration (IN PROGRESS) +**Goal:** Enable Claude Code to generate skills directly +**Timeline:** Week of Oct 19-26 + +**Tasks:** +- [x] Monorepo refactor (cli/ and mcp/) +- [x] MCP server skeleton with 6 tools +- [x] Basic tool implementations +- [ ] Fix remaining test failures +- [ ] Test with actual Claude Code +- [ ] MCP documentation and examples +- [ ] Release announcement + +**Deliverables:** +- Working MCP server +- Setup guide for Claude Code +- Example workflows + +--- + +### 📋 v1.2 - Enhanced MCP Features (PLANNED) +**Goal:** Make MCP tools more powerful and user-friendly +**Timeline:** Nov 2025 + +**Features:** +- Interactive config wizard via MCP +- Real-time progress updates +- Auto-detect documentation patterns +- Parallel terminal enhancement support +- Batch operations + +**Use Cases:** +- "Auto-configure for Next.js docs" +- "Generate configs for: React, Vue, Svelte" +- "Show progress while scraping" + +--- + +### 📋 v2.0 - Intelligence Layer (PLANNED) +**Goal:** Smart defaults and auto-configuration +**Timeline:** Dec 2025 + +**Features:** +- **Auto-detection:** + - Automatically find best selectors + - Detect documentation framework (Docusaurus, GitBook, etc.) + - Suggest optimal rate_limit and max_pages + +- **Quality Metrics:** + - Analyze generated SKILL.md quality + - Suggest improvements + - Validate code examples + +- **Templates:** + - Pre-built configs for popular frameworks + - Community config sharing + - One-click generation for common docs + +**Example:** +``` +User: "Create skill from https://tailwindcss.com/docs" +Tool: Auto-detects Tailwind, uses template, generates in 30 seconds +``` + +--- + +### 💭 v3.0 - Platform Features (IDEAS) +**Goal:** Build ecosystem around skill generation + +**Possible Features:** +- Web UI for config generation +- GitHub Actions integration +- Skill marketplace +- Analytics dashboard +- API for programmatic access + +--- + +## 🎨 Feature Ideas + +### High Priority +1. **Selector Auto-Detection** - Analyze page, suggest selectors +2. **Progress Streaming** - Real-time updates during scraping +3. **Config Validation UI** - Visual feedback on config quality +4. **Batch Processing** - Handle multiple sites at once + +### Medium Priority +5. **Skill Quality Score** - Rate generated skills +6. **Enhanced SKILL.md** - Better templates, more examples +7. **Documentation Framework Detection** - Auto-detect Docusaurus, VuePress, etc. +8. **Custom Categories AI** - Use AI to suggest categories + +### Low Priority +9. **Web Dashboard** - Browser-based interface +10. **Skill Analytics** - Track usage, quality metrics +11. **Community Configs** - Share and discover configs +12. **Plugin System** - Extend with custom scrapers + +--- + +## 🔬 Research Areas + +### MCP Enhancements +- [ ] Investigate MCP progress/streaming APIs +- [ ] Test MCP with large documentation sites +- [ ] Explore MCP caching strategies + +### AI Integration +- [ ] Use Claude to auto-generate categories +- [ ] AI-powered selector detection +- [ ] Quality analysis with LLMs + +### Performance +- [ ] Parallel scraping +- [ ] Incremental updates +- [ ] Smart caching + +--- + +## 📊 Metrics & Goals + +### Current State (Oct 2025) +- ✅ 7 preset configs +- ✅ 71 tests (95.8% passing) +- ✅ 6 MCP tools +- ✅ ~2500 lines of code + +### Goals for v1.1 +- 🎯 100% test pass rate +- 🎯 5+ users testing MCP +- 🎯 10+ documentation sites tested +- 🎯 <5 minute setup time + +### Goals for v2.0 +- 🎯 50+ preset configs +- 🎯 Auto-detection for 80%+ of sites +- 🎯 <1 minute skill generation +- 🎯 Community contributions + +--- + +## 🤝 Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for: +- How to add new MCP tools +- Testing guidelines +- Code style +- PR process + +--- + +## 📅 Release Schedule + +| Version | Target Date | Focus | +|---------|-------------|-------| +| v1.0 | Oct 15, 2025 | Core CLI ✅ | +| v1.1 | Oct 26, 2025 | MCP Integration 🚧 | +| v1.2 | Nov 2025 | Enhanced MCP 📋 | +| v2.0 | Dec 2025 | Intelligence 💭 | +| v3.0 | Q1 2026 | Platform 💭 | + +--- + +## 🔗 Related Projects + +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Claude Code](https://claude.ai/code) +- Documentation frameworks we support + +--- + +**Last Updated:** October 19, 2025 diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..bb12c0d --- /dev/null +++ b/TODO.md @@ -0,0 +1,53 @@ +# Skill Seeker MCP Development Plan + +## Phase 1: MCP Core ✅ DONE +- [x] Refactor to monorepo structure +- [x] Create MCP server skeleton +- [x] Implement 6 basic tools +- [x] Update tests for new structure + +## Phase 2: MCP Enhancement 🚧 IN PROGRESS +- [ ] Fix remaining 3 test failures +- [ ] Add MCP configuration examples +- [ ] Test MCP server with Claude Code +- [ ] Add error handling improvements +- [ ] Add logging to MCP tools + +## Phase 3: Advanced MCP Features 📋 PLANNED +- [ ] Interactive config generation (wizard-style) +- [ ] Real-time progress updates +- [ ] Parallel terminal support for enhancement +- [ ] Batch operations (multiple configs at once) +- [ ] Config templates for popular frameworks + +## Phase 4: Documentation & Polish 📋 PLANNED +- [ ] Update main README for monorepo +- [ ] Create MCP setup guide with screenshots +- [ ] Add video tutorial +- [ ] Create example workflows +- [ ] Performance optimization + +## Phase 5: Advanced Integrations 💭 IDEAS +- [ ] Web interface for config generation +- [ ] GitHub Actions integration +- [ ] Auto-discovery of documentation patterns +- [ ] Skill quality metrics +- [ ] Community config repository + +--- + +## Current Sprint (Week of Oct 19) + +### Priority Tasks +1. [ ] Fix 3 test failures (warnings vs errors) +2. [ ] Create `.claude/mcp_config.json` example +3. [ ] Test MCP with actual Claude Code +4. [ ] Document MCP setup process + +### Blockers +- None + +### Notes +- MCP server uses stdio protocol +- All CLI tools work via subprocess +- Tests at 95.8% (68/71 passing)