codemap_project_help_edit
Edit an existing project help topic with updated markdown content
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
topic | string | ✅ Required | Help topic name |
content | string | ✅ Required | Updated markdown content |
Usage Examples
MCP Usage (for AI Agents like Claude)
json
{
"name": "codemap_project_help_edit",
"arguments": {
"topic": "build-process",
"content": "# Build Process (Updated)\n\n...updated content..."
}
}Example Output
JSON Response
json
{
"success": true,
"message": "Help topic 'build-process' updated successfully",
"topic": "build-process"
}When to Use This Tool
-
Use
- Update documentation as processes change
- Fix errors or outdated information in topics
- Add new sections to existing documentation
- Improve clarity based on team feedback
codemap_project_help_edit when you need to:
Common Patterns
Iterative Improvement Pattern
1. Team uses help topic
2. Identifies missing or unclear information
3. Edit topic with improvements
4. Republish to teamPro Tips
- Must exist: Topic must already exist - use
addto create new topics - Complete replacement: Edit replaces entire content, not partial updates
- Version history: Consider keeping versioned backups of important documentation
Best Practices
- Review topic before editing to understand current content
- Document what changed in commit messages
- Notify team when updating frequently-used topics
- Test updated content with someone unfamiliar with the process
Common Mistakes
❌ Mistake: Using edit to create new topics
✅ Instead: Use
❌ Mistake: Making breaking changes without team communication
✅ Instead: Notify team before major documentation updates
❌ Mistake: Forgetting edit replaces entire content
✅ Instead: Get current content first if only making small changes
✅ Instead: Use
project_help_add for new topics - edit is only for existing ones❌ Mistake: Making breaking changes without team communication
✅ Instead: Notify team before major documentation updates
❌ Mistake: Forgetting edit replaces entire content
✅ Instead: Get current content first if only making small changes