codemap_routine_add_help
Add a help topic reference to a routine for documentation and guidance
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
routineName | string | ✅ Required | Routine name |
topicName | string | ✅ Required | Help topic name to add |
Usage Examples
MCP Usage (for AI Agents like Claude)
json
{
"name": "codemap_routine_add_help",
"arguments": {
"routineName": "pre-publish",
"topicName": "build-process"
}
}Example Output
JSON Response
json
{
"success": true,
"message": "Help topic 'build-process' added to routine 'pre-publish'"
}When to Use This Tool
-
Use
- Provide documentation and context for complex routines
- Link relevant guides to workflow steps
- Help team members understand routine purpose
- Surface important information during routine execution
codemap_routine_add_help when you need to:
Common Patterns
Documentation Integration Pattern
1. Create help topic with detailed guide
2. Add topic to routine
3. Help displays when routine runs
4. Team has context and guidancePro Tips
- Displays automatically: Help topics show when routine runs
- Multiple topics: Can add multiple help topics to one routine
- Contextual guidance: Add topics relevant to specific workflow steps
Best Practices
- Add help topics that explain complex or non-obvious steps
- Link to troubleshooting guides for error-prone processes
- Update help topics when routine changes
- Use descriptive topic names
Common Mistakes
❌ Mistake: Adding generic help not relevant to routine
✅ Instead: Choose topics specifically related to the workflow
❌ Mistake: Not updating help when routine changes
✅ Instead: Review and update linked help topics regularly
✅ Instead: Choose topics specifically related to the workflow
❌ Mistake: Not updating help when routine changes
✅ Instead: Review and update linked help topics regularly