48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
|
# Task ID: 112
|
||
|
|
|
||
|
|
**Title:** Write Documentation for ProxyModel Authoring
|
||
|
|
|
||
|
|
**Status:** done
|
||
|
|
|
||
|
|
**Dependencies:** 71 ✓, 78 ✓, 93 ✗, 94 ✗
|
||
|
|
|
||
|
|
**Priority:** low
|
||
|
|
|
||
|
|
**Description:** Create comprehensive documentation for users wanting to create custom stages and proxymodels.
|
||
|
|
|
||
|
|
**Details:**
|
||
|
|
|
||
|
|
Create documentation covering:
|
||
|
|
|
||
|
|
1. `docs/proxymodels/authoring-guide.md` - Complete guide from PRD's "Authoring Guide" section:
|
||
|
|
- Concepts: stages, proxymodels, framework
|
||
|
|
- File locations
|
||
|
|
- Step-by-step stage creation
|
||
|
|
- Step-by-step proxymodel creation
|
||
|
|
- Testing with mcpctl proxymodel validate
|
||
|
|
- Section drill-down
|
||
|
|
- Cache usage
|
||
|
|
- Error handling
|
||
|
|
- Full example
|
||
|
|
|
||
|
|
2. `docs/proxymodels/built-in-stages.md` - Reference for all built-in stages:
|
||
|
|
- passthrough
|
||
|
|
- paginate
|
||
|
|
- section-split
|
||
|
|
- summarize-tree
|
||
|
|
- Config options for each
|
||
|
|
|
||
|
|
3. `docs/proxymodels/api-reference.md` - Type reference:
|
||
|
|
- StageHandler
|
||
|
|
- StageContext
|
||
|
|
- StageResult
|
||
|
|
- Section
|
||
|
|
- LLMProvider
|
||
|
|
- CacheProvider
|
||
|
|
|
||
|
|
4. Update main README with proxymodels overview.
|
||
|
|
|
||
|
|
**Test Strategy:**
|
||
|
|
|
||
|
|
Review documentation for completeness, verify all code examples compile, test example stage from documentation works end-to-end.
|