codemap_project_help_add
Create or update a project help topic with markdown content
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
topic | string | ✅ Required | Help topic name |
content | string | ✅ Required | Markdown content for the help topic |
Usage Examples
MCP Usage (for AI Agents like Claude)
json
{
"name": "codemap_project_help_add",
"arguments": {
"topic": "build-process",
"content": "# Build Process\n\n## Quick Build\n\nUse `clean-build.bat` in `packages/codemap/`:\n- Cleans dist directory\n- Runs TypeScript compiler\n- Generates type definitions\n\n## Publishing\n\nExample Output
JSON Response
json
{
"success": true,
"message": "Help topic 'build-process' created successfully",
"topic": "build-process",
"path": ".codemap/project-help/build-process.md"
}When to Use This Tool
-
Use
- Document project-specific processes and workflows
- Create guides for complex or non-obvious procedures
- Consolidate scattered documentation into one place
- Share knowledge about project conventions
- Build onboarding documentation for new team members
codemap_project_help_add when you need to:
Common Patterns
Documentation First Pattern
Knowledge Transfer Pattern
1. Start new complex process
2. Document it as you go
3. Add as help topic immediately
4. Reference in future workKnowledge Transfer Pattern
1. Expert documents their process
2. Add as help topic
3. Team references when needed
4. Update based on feedbackPro Tips
- Markdown format: Use full markdown formatting for rich documentation
- Surfaces automatically: Topics appear in
codemap_orientoutput - Updatable: Calling add with existing topic name updates it
- File storage: Topics stored in
.codemap/project-help/as.mdfiles
Best Practices
- Use clear, descriptive topic names (build-process, deployment, testing-guide)
- Include both procedural steps and conceptual explanations
- Add code examples and commands where relevant
- Link to related topics and external resources
- Update topics when processes change
Common Mistakes
❌ Mistake: Writing documentation elsewhere instead of help topics
✅ Instead: Centralize project docs in help topics so they surface in orient
❌ Mistake: Creating topics that duplicate general CodeMap help
✅ Instead: Focus on project-specific information unique to your codebase
❌ Mistake: Not updating topics when processes change
✅ Instead: Review and update help topics regularly
✅ Instead: Centralize project docs in help topics so they surface in orient
❌ Mistake: Creating topics that duplicate general CodeMap help
✅ Instead: Focus on project-specific information unique to your codebase
❌ Mistake: Not updating topics when processes change
✅ Instead: Review and update help topics regularly