@meldocio/mcp-stdio-proxy 1.0.25 → 1.0.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.claude-plugin/skills/advanced-workflows.md +697 -0
- package/.claude-plugin/skills/collaboration.md +447 -0
- package/.claude-plugin/skills/documentation-writing.md +548 -0
- package/.claude-plugin/{SKILL.md → skills/meldoc-overview.md} +10 -5
- package/.claude-plugin/skills/onboarding.md +839 -0
- package/.claude-plugin/skills/search-and-discovery.md +389 -0
- package/README.md +18 -7
- package/lib/http/client.js +26 -3
- package/package.json +1 -1
|
@@ -0,0 +1,447 @@
|
|
|
1
|
+
# Meldoc Collaboration Assistant
|
|
2
|
+
|
|
3
|
+
Expert at facilitating team collaboration on documentation in Meldoc.
|
|
4
|
+
|
|
5
|
+
## When to Use This Skill
|
|
6
|
+
|
|
7
|
+
Use this skill when:
|
|
8
|
+
- Multiple people are working on documentation
|
|
9
|
+
- Managing documentation reviews
|
|
10
|
+
- Coordinating documentation updates
|
|
11
|
+
- Planning documentation projects
|
|
12
|
+
- Resolving documentation conflicts
|
|
13
|
+
|
|
14
|
+
## Collaboration Workflows
|
|
15
|
+
|
|
16
|
+
### Coordinated Updates
|
|
17
|
+
|
|
18
|
+
When multiple people need to work on related docs:
|
|
19
|
+
|
|
20
|
+
1. **Check current structure:**
|
|
21
|
+
```javascript
|
|
22
|
+
docs_tree({ projectId: "..." })
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
2. **Identify who owns what:**
|
|
26
|
+
- Use `docs_get` to see last updated info
|
|
27
|
+
- Check backlinks to see dependencies
|
|
28
|
+
- Plan non-conflicting areas
|
|
29
|
+
|
|
30
|
+
3. **Suggest work division:**
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
Person A: Update sections 1-3
|
|
34
|
+
Person B: Update sections 4-6
|
|
35
|
+
Person C: Create new examples
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
4. **Track changes:**
|
|
39
|
+
- Use `expectedUpdatedAt` for optimistic locking
|
|
40
|
+
- Review links between documents
|
|
41
|
+
- Ensure consistency
|
|
42
|
+
|
|
43
|
+
### Documentation Reviews
|
|
44
|
+
|
|
45
|
+
Help teams review documentation:
|
|
46
|
+
|
|
47
|
+
1. **Find recent changes:**
|
|
48
|
+
|
|
49
|
+
```javascript
|
|
50
|
+
docs_list({ projectId: "..." })
|
|
51
|
+
// Sort by updated date
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
2. **Check for issues:**
|
|
55
|
+
- Broken links (docs that were deleted)
|
|
56
|
+
- Orphaned documents (no parent, no backlinks)
|
|
57
|
+
- Duplicate content
|
|
58
|
+
|
|
59
|
+
3. **Suggest improvements:**
|
|
60
|
+
- Missing links (should use `[[alias]]` magic links)
|
|
61
|
+
- Unclear structure
|
|
62
|
+
- Needed clarifications
|
|
63
|
+
|
|
64
|
+
### Documentation Planning
|
|
65
|
+
|
|
66
|
+
When planning a documentation project:
|
|
67
|
+
|
|
68
|
+
1. **Assess current state:**
|
|
69
|
+
|
|
70
|
+
```javascript
|
|
71
|
+
docs_tree({ projectId: "..." })
|
|
72
|
+
docs_search({ query: "related topic" })
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
2. **Identify gaps:**
|
|
76
|
+
- Missing documents
|
|
77
|
+
- Under-documented areas
|
|
78
|
+
- Outdated content
|
|
79
|
+
|
|
80
|
+
3. **Create roadmap:**
|
|
81
|
+
|
|
82
|
+
```markdown
|
|
83
|
+
## Documentation Roadmap
|
|
84
|
+
|
|
85
|
+
### Phase 1: Foundation
|
|
86
|
+
- [ ] Update getting started guide
|
|
87
|
+
- [ ] Create API overview
|
|
88
|
+
- [ ] Add code examples
|
|
89
|
+
|
|
90
|
+
### Phase 2: Deep Dives
|
|
91
|
+
- [ ] Write advanced tutorials
|
|
92
|
+
- [ ] Document edge cases
|
|
93
|
+
- [ ] Add troubleshooting guides
|
|
94
|
+
|
|
95
|
+
### Phase 3: Polish
|
|
96
|
+
- [ ] Review all links
|
|
97
|
+
- [ ] Add diagrams
|
|
98
|
+
- [ ] Improve navigation
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
4. **Assign tasks:**
|
|
102
|
+
- Based on expertise
|
|
103
|
+
- Considering dependencies
|
|
104
|
+
- With deadlines
|
|
105
|
+
|
|
106
|
+
## Team Patterns
|
|
107
|
+
|
|
108
|
+
### Pattern: Documentation Sprint
|
|
109
|
+
|
|
110
|
+
1. **Day 1: Planning**
|
|
111
|
+
- Review current docs
|
|
112
|
+
- List needed updates
|
|
113
|
+
- Assign sections
|
|
114
|
+
- Set standards
|
|
115
|
+
|
|
116
|
+
2. **Day 2-4: Writing**
|
|
117
|
+
- Create/update docs with proper frontmatter
|
|
118
|
+
- Review each other's work
|
|
119
|
+
- Maintain consistency
|
|
120
|
+
|
|
121
|
+
3. **Day 5: Review & Polish**
|
|
122
|
+
- Check all links (use `[[alias]]` format)
|
|
123
|
+
- Ensure consistency
|
|
124
|
+
- Fix issues
|
|
125
|
+
- Publish
|
|
126
|
+
|
|
127
|
+
### Pattern: Continuous Documentation
|
|
128
|
+
|
|
129
|
+
1. **With each feature:**
|
|
130
|
+
- Developer creates draft with `workflow: "draft"`
|
|
131
|
+
- Technical writer polishes
|
|
132
|
+
- Reviewer approves
|
|
133
|
+
- Link to related docs using `[[alias]]`
|
|
134
|
+
|
|
135
|
+
2. **Weekly review:**
|
|
136
|
+
- Check for gaps
|
|
137
|
+
- Update outdated content
|
|
138
|
+
- Improve clarity
|
|
139
|
+
|
|
140
|
+
3. **Monthly audit:**
|
|
141
|
+
- Review entire doc tree
|
|
142
|
+
- Plan major updates
|
|
143
|
+
- Archive obsolete docs
|
|
144
|
+
|
|
145
|
+
### Pattern: Expert Review Cycle
|
|
146
|
+
|
|
147
|
+
1. **Draft creation:**
|
|
148
|
+
|
|
149
|
+
```javascript
|
|
150
|
+
docs_create({
|
|
151
|
+
title: "Feature Name",
|
|
152
|
+
alias: "feature-name",
|
|
153
|
+
contentMd: `---
|
|
154
|
+
alias: feature-name
|
|
155
|
+
title: Feature Name
|
|
156
|
+
workflow: draft
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## Overview
|
|
160
|
+
|
|
161
|
+
Initial content...
|
|
162
|
+
`,
|
|
163
|
+
workflow: "draft"
|
|
164
|
+
})
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
2. **Expert review:**
|
|
168
|
+
- Subject matter expert reviews
|
|
169
|
+
- Suggests changes
|
|
170
|
+
- Adds technical details
|
|
171
|
+
|
|
172
|
+
3. **Editorial polish:**
|
|
173
|
+
- Technical writer improves clarity
|
|
174
|
+
- Fixes formatting
|
|
175
|
+
- Adds examples
|
|
176
|
+
|
|
177
|
+
4. **Publication:**
|
|
178
|
+
|
|
179
|
+
```javascript
|
|
180
|
+
docs_update({
|
|
181
|
+
docId: "...",
|
|
182
|
+
contentMd: `---
|
|
183
|
+
alias: feature-name
|
|
184
|
+
title: Feature Name
|
|
185
|
+
workflow: published
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## Overview
|
|
189
|
+
|
|
190
|
+
Final content...
|
|
191
|
+
`
|
|
192
|
+
})
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Conflict Resolution
|
|
196
|
+
|
|
197
|
+
### Handling Simultaneous Edits
|
|
198
|
+
|
|
199
|
+
When two people edit the same document:
|
|
200
|
+
|
|
201
|
+
```javascript
|
|
202
|
+
// Person A tries to update
|
|
203
|
+
docs_update({
|
|
204
|
+
docId: "123",
|
|
205
|
+
contentMd: "New content from A...",
|
|
206
|
+
expectedUpdatedAt: "2025-01-01T10:00:00Z"
|
|
207
|
+
})
|
|
208
|
+
|
|
209
|
+
// Error: Document was updated since you loaded it
|
|
210
|
+
|
|
211
|
+
// Solution:
|
|
212
|
+
// 1. Get latest version
|
|
213
|
+
docs_get({ docId: "123" })
|
|
214
|
+
|
|
215
|
+
// 2. Merge changes manually or
|
|
216
|
+
// 3. Decide whose changes take priority
|
|
217
|
+
// 4. Update with new expectedUpdatedAt
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
**Best practice:** Communicate before editing!
|
|
221
|
+
|
|
222
|
+
### Managing Different Perspectives
|
|
223
|
+
|
|
224
|
+
When team members have different views:
|
|
225
|
+
|
|
226
|
+
1. **Document both perspectives:**
|
|
227
|
+
|
|
228
|
+
```markdown
|
|
229
|
+
---
|
|
230
|
+
alias: feature-approaches
|
|
231
|
+
title: Feature Approaches
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## Approach A
|
|
235
|
+
[Description of approach A]
|
|
236
|
+
|
|
237
|
+
## Approach B
|
|
238
|
+
[Description of approach B]
|
|
239
|
+
|
|
240
|
+
## Team Decision
|
|
241
|
+
We chose Approach A because [reasons]
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
2. **Link to discussions:**
|
|
245
|
+
- Add links to Slack threads
|
|
246
|
+
- Reference meeting notes
|
|
247
|
+
- Link to decision documents using `[[alias]]`
|
|
248
|
+
|
|
249
|
+
3. **Maintain history:**
|
|
250
|
+
- Don't delete old approaches
|
|
251
|
+
- Explain why changed
|
|
252
|
+
- Keep for reference
|
|
253
|
+
|
|
254
|
+
## Communication Helpers
|
|
255
|
+
|
|
256
|
+
### Documentation Status Updates
|
|
257
|
+
|
|
258
|
+
Generate status for team:
|
|
259
|
+
|
|
260
|
+
```markdown
|
|
261
|
+
## Documentation Status - Week of [Date]
|
|
262
|
+
|
|
263
|
+
### Completed
|
|
264
|
+
- ✅ Updated API Reference
|
|
265
|
+
- ✅ Created Getting Started Guide
|
|
266
|
+
- ✅ Fixed 12 broken links
|
|
267
|
+
|
|
268
|
+
### In Progress
|
|
269
|
+
- 🔄 Authentication Tutorial (John)
|
|
270
|
+
- 🔄 Advanced Features Guide (Sarah)
|
|
271
|
+
|
|
272
|
+
### Planned
|
|
273
|
+
- 📋 Troubleshooting Guide
|
|
274
|
+
- 📋 Migration Guide
|
|
275
|
+
- 📋 FAQ Updates
|
|
276
|
+
|
|
277
|
+
### Issues
|
|
278
|
+
- ⚠️ Need review: Database Schema Doc
|
|
279
|
+
- ⚠️ Missing: Deployment Guide
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### Review Requests
|
|
283
|
+
|
|
284
|
+
Format review requests:
|
|
285
|
+
|
|
286
|
+
```markdown
|
|
287
|
+
## Review Needed: [Document Title]
|
|
288
|
+
|
|
289
|
+
**Document:** [[doc-alias]]
|
|
290
|
+
**Author:** [Name]
|
|
291
|
+
**Changes:**
|
|
292
|
+
- Added section on [topic]
|
|
293
|
+
- Updated examples
|
|
294
|
+
- Fixed typos
|
|
295
|
+
|
|
296
|
+
**Review focus:**
|
|
297
|
+
- Technical accuracy of new section
|
|
298
|
+
- Clarity of examples
|
|
299
|
+
- Completeness
|
|
300
|
+
|
|
301
|
+
**Deadline:** [Date]
|
|
302
|
+
|
|
303
|
+
Please use `docs_get` to review and provide feedback here.
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### Documentation Metrics
|
|
307
|
+
|
|
308
|
+
Track documentation health:
|
|
309
|
+
|
|
310
|
+
```javascript
|
|
311
|
+
// Get all docs
|
|
312
|
+
docs_list({ projectId: "..." })
|
|
313
|
+
|
|
314
|
+
// Analyze:
|
|
315
|
+
// - Total document count
|
|
316
|
+
// - Recently updated (last 30 days)
|
|
317
|
+
// - Orphaned docs (no backlinks)
|
|
318
|
+
// - Highly connected docs (many backlinks)
|
|
319
|
+
// - Documents needing review
|
|
320
|
+
|
|
321
|
+
// Present summary:
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
```markdown
|
|
325
|
+
## Documentation Health Report
|
|
326
|
+
|
|
327
|
+
**Total Documents:** 156
|
|
328
|
+
**Updated This Month:** 23
|
|
329
|
+
**Needs Attention:** 8
|
|
330
|
+
|
|
331
|
+
### Top Connected Documents
|
|
332
|
+
1. [[getting-started]] (45 backlinks)
|
|
333
|
+
2. [[api-reference]] (38 backlinks)
|
|
334
|
+
3. [[configuration-guide]] (29 backlinks)
|
|
335
|
+
|
|
336
|
+
### Orphaned Documents
|
|
337
|
+
- Old Migration Guide (no backlinks)
|
|
338
|
+
- Deprecated API v1 Docs (no backlinks)
|
|
339
|
+
|
|
340
|
+
### Recommendations
|
|
341
|
+
- Archive deprecated docs
|
|
342
|
+
- Update orphaned docs or delete
|
|
343
|
+
- Create links to recently added docs using `[[alias]]`
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
## Best Practices
|
|
347
|
+
|
|
348
|
+
### Communication
|
|
349
|
+
|
|
350
|
+
- **Before editing:** Check who last updated
|
|
351
|
+
- **During editing:** Communicate with team
|
|
352
|
+
- **After editing:** Notify relevant people
|
|
353
|
+
- **Use comments:** In Meldoc or external tools
|
|
354
|
+
|
|
355
|
+
### Standards
|
|
356
|
+
|
|
357
|
+
Establish and follow:
|
|
358
|
+
|
|
359
|
+
- Naming conventions (kebab-case aliases)
|
|
360
|
+
- Document structure templates (with frontmatter)
|
|
361
|
+
- Style guide
|
|
362
|
+
- Review process
|
|
363
|
+
- Update frequency
|
|
364
|
+
|
|
365
|
+
### Tools Integration
|
|
366
|
+
|
|
367
|
+
Coordinate with:
|
|
368
|
+
|
|
369
|
+
- Slack for notifications
|
|
370
|
+
- Jira for task tracking
|
|
371
|
+
- GitHub for code-doc sync
|
|
372
|
+
- Calendar for deadlines
|
|
373
|
+
|
|
374
|
+
## Team Roles
|
|
375
|
+
|
|
376
|
+
### Documentation Owner
|
|
377
|
+
|
|
378
|
+
- Maintains overall structure
|
|
379
|
+
- Enforces standards
|
|
380
|
+
- Resolves conflicts
|
|
381
|
+
- Plans initiatives
|
|
382
|
+
|
|
383
|
+
### Technical Writers
|
|
384
|
+
|
|
385
|
+
- Polish content
|
|
386
|
+
- Improve clarity
|
|
387
|
+
- Maintain consistency
|
|
388
|
+
- Create templates
|
|
389
|
+
|
|
390
|
+
### Subject Matter Experts
|
|
391
|
+
|
|
392
|
+
- Provide technical accuracy
|
|
393
|
+
- Review for correctness
|
|
394
|
+
- Add deep insights
|
|
395
|
+
- Validate examples
|
|
396
|
+
|
|
397
|
+
### Reviewers
|
|
398
|
+
|
|
399
|
+
- Check clarity
|
|
400
|
+
- Test procedures
|
|
401
|
+
- Verify links (ensure `[[alias]]` format)
|
|
402
|
+
- Suggest improvements
|
|
403
|
+
|
|
404
|
+
## Common Scenarios
|
|
405
|
+
|
|
406
|
+
### "Someone deleted my work"
|
|
407
|
+
|
|
408
|
+
1. Check document history (if available)
|
|
409
|
+
2. Use `docs_get` to see current state
|
|
410
|
+
3. Compare with your version
|
|
411
|
+
4. Communicate with team
|
|
412
|
+
5. Merge changes if needed
|
|
413
|
+
|
|
414
|
+
### "Which document should I update?"
|
|
415
|
+
|
|
416
|
+
1. Search for the topic
|
|
417
|
+
2. Check document tree
|
|
418
|
+
3. Find most relevant doc
|
|
419
|
+
4. Check backlinks (how connected?)
|
|
420
|
+
5. Update primary doc, link from others using `[[alias]]`
|
|
421
|
+
|
|
422
|
+
### "How do I organize this?"
|
|
423
|
+
|
|
424
|
+
1. Review existing structure
|
|
425
|
+
2. Find similar document groups
|
|
426
|
+
3. Create parent if needed (with proper frontmatter)
|
|
427
|
+
4. Link related docs using `[[alias]]`
|
|
428
|
+
5. Update tree as you go
|
|
429
|
+
|
|
430
|
+
### "Need to archive old docs"
|
|
431
|
+
|
|
432
|
+
1. Identify obsolete content
|
|
433
|
+
2. Check backlinks (anything still referencing?)
|
|
434
|
+
3. Update links to point to new docs using `[[alias]]`
|
|
435
|
+
4. Mark as deprecated or delete
|
|
436
|
+
5. Notify team
|
|
437
|
+
|
|
438
|
+
## Success Metrics
|
|
439
|
+
|
|
440
|
+
Great collaboration shows:
|
|
441
|
+
|
|
442
|
+
- Regular updates from multiple people
|
|
443
|
+
- Few conflicts/overwrites
|
|
444
|
+
- Well-connected document graph (using `[[alias]]` links)
|
|
445
|
+
- Quick review turnaround
|
|
446
|
+
- Consistent style across docs
|
|
447
|
+
- High team satisfaction
|