codemap_project_help
Read or list project-specific help documentation stored in .codemap/project-help/
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
topic | string | ❌ Optional | Help topic name (omit to list all topics) |
Usage Examples
MCP Usage (for AI Agents like Claude)
json
{
"name": "codemap_project_help",
"arguments": {}
}Example Output
JSON Response
json
{
"success": true,
"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",
"size": 1024,
"lastModified": "2026-04-11T12:30:45.123Z"
}When to Use This Tool
-
Use
- Discover what project-specific documentation exists
- Read detailed guides about project processes
- Access centralized project knowledge during development
- Share documentation that surfaces in orient output
- Document project-specific workflows and conventions
codemap_project_help when you need to:
Common Patterns
Discovery Pattern
Orient Integration
1. Run codemap_project_help() to see topics
2. Read relevant topic for current task
3. Follow documented processOrient Integration
1. Topics automatically surface in codemap_orient
2. Click or reference topics as needed
3. Consolidated project knowledge in one placePro Tips
- Surfaces in orient: Help topics appear in session orientation output automatically
- Markdown format: All topics stored as markdown files in
.codemap/project-help/ - Project-specific: Unlike global CodeMap help, this is unique to your project
- Searchable: Use
codemap_search_in_filesto search help content
Best Practices
- Read help topics before starting complex tasks
- Keep topics updated as processes change
- Use consistent naming for topics (kebab-case)
- Document both "how" and "why" in topics
- Link related topics in content
Common Mistakes
❌ Mistake: Confusing with global CodeMap help
✅ Instead: This is project-specific docs, not general CodeMap documentation
❌ Mistake: Not reading topics before asking questions
✅ Instead: Check help topics first - answers might already be documented
❌ Mistake: Ignoring topics shown in orient output
✅ Instead: Review new topics when they appear in orientation
✅ Instead: This is project-specific docs, not general CodeMap documentation
❌ Mistake: Not reading topics before asking questions
✅ Instead: Check help topics first - answers might already be documented
❌ Mistake: Ignoring topics shown in orient output
✅ Instead: Review new topics when they appear in orientation