Skip to content

Commit e0b32a7

Browse files
committed
docs: add Claude Code integration tips for claude.md
1 parent acf5344 commit e0b32a7

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,70 @@ search_codebase({
553553
- Best for complex queries beyond simple search/traversal
554554
- Currently in development - may require setup
555555

556+
## Claude Code Integration Tips
557+
558+
### Guiding Tool Usage with claude.md
559+
560+
You can add a `claude.md` file to your repository root to help Claude Code understand when to use these MCP tools effectively. Here are some useful patterns:
561+
562+
#### Trigger Word Hints
563+
564+
```markdown
565+
## Code Search Tools
566+
567+
**Use `search_codebase` for:**
568+
- "Where is...", "Find...", "Show me [specific thing]"
569+
- Example: "Where is the authentication middleware?"
570+
571+
**Use `natural_language_to_cypher` for:**
572+
- "List all...", "How many...", "Count..."
573+
- Example: "List all API controllers"
574+
575+
**Use `traverse_from_node` for:**
576+
- Deep dependency analysis after initial search
577+
- "What depends on X?", "Trace the flow..."
578+
```
579+
580+
#### Weighted Traversal Hints
581+
582+
```markdown
583+
**Use `useWeightedTraversal: true` for:**
584+
- Service/Controller classes with many dependencies
585+
- Queries with depth > 3 or limit > 10
586+
- Cleaner, more relevant results
587+
588+
**Recommended settings:**
589+
- Default: `limit: 15, maxDepth: 5, snippetLength: 900`
590+
- Simple lookups: `limit: 5, maxDepth: 2`
591+
```
592+
593+
#### Framework-Specific Patterns
594+
595+
Document your custom node types and relationships so Claude knows what to search for:
596+
597+
```markdown
598+
**Custom Node Types:**
599+
- `PaymentProcessor` - Payment integrations
600+
- `EmailTemplate` - Email templates
601+
602+
**Custom Relationships:**
603+
- `PROCESSES_PAYMENT` - Service → PaymentProcessor
604+
- `SENDS_EMAIL` - Service → EmailTemplate
605+
```
606+
607+
#### Common Query Examples
608+
609+
```markdown
610+
**Finding authentication:**
611+
search_codebase({ query: "JWT authentication middleware" })
612+
613+
**Tracing dependencies:**
614+
traverse_from_node({ nodeId: "...", direction: "OUTGOING", maxDepth: 5 })
615+
616+
**Impact analysis:**
617+
traverse_from_node({ nodeId: "...", direction: "INCOMING", maxDepth: 4 })
618+
```
619+
556620
## Framework Support
557621

558622
### NestJS Framework Schema

0 commit comments

Comments
 (0)