codemap_help
Get help documentation for CodeMap tools and workflows. Returns formatted markdown documentation for specific topics or index of all available topics.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
topic | string | ❌ Optional | Help topic ID (e.g., 'getting-started', 'search-patterns', 'file-operations'). Empty or 'index' for full list of topics. |
Usage Examples
MCP Usage (for AI Agents like Claude)
json
{
"name": "codemap_help",
"arguments": {
}
}Example Output
JSON Response
json
{
"success": true,
"topic": "search-patterns",
"content": "# Search Patterns\n\n## Overview\nCodeMap supports multiple search modes for finding files and symbols:\n\n### Text Search (Default)\nSearches file names and symbol names as plain text...\n\n### Symbol Search \nFinds specific symbol types (functions, classes, interfaces)...\n\n### Hybrid Search\nCombines text and symbol search for best results...\n\n## Examples\n\n### Basic Search\n```typescript\ncodemap_search({ query: 'authentication' })\n```\n\n### Symbol-Specific Search\n```typescript\ncodemap_search({ \n query: 'User',\n mode: 'symbol',\n symbolKind: 'class'\n})\n```\n\nSee documentation for full search capabilities."
}When to Use This Tool
-
Use
- Learn about CodeMap features and tools
- Understand search patterns and workflows
- Get quick reference for tool usage
- Discover available help topics
- Learn best practices for specific operations
codemap_help when you need to:
Pro Tips
- Start with index: Call with no topic to see all available help
- Topic IDs are lowercase-hyphenated: e.g., "search-patterns", "file-operations"
- Plugins can add topics: Custom plugins may register their own help content
- Markdown format: Help content is formatted markdown for readability
- Context-aware: Help is tailored to your current project setup
Best Practices
- Browse index first to discover available topics
- Use specific topics when you know what you're looking for
- Bookmark commonly used help topics for quick reference
Common Mistakes
❌ Mistake: Guessing topic IDs
✅ Instead: Call
❌ Mistake: Expecting comprehensive documentation in chat
✅ Instead: Use help system for quick reference, full docs on website
✅ Instead: Call
codemap_help() with no args to see available topics❌ Mistake: Expecting comprehensive documentation in chat
✅ Instead: Use help system for quick reference, full docs on website