Skip to content

Commit db214fc

Browse files
authored
docs: add MCP Server Usage Policy and examples to CLAUDE.md (#1449)
## Description - Introduced a new section detailing the usage policy for MCP (Model Context Protocol) servers. - Listed recommended MCPs for the project along with their specific use cases (only if the MCP servers are available in the current claude-code instance). - Provided usage examples for various scenarios, enhancing guidance for developers. - Included a quick reference for library documentation using the context7 MCP. ## What type of PR is this? (check all applicable) - [ ] 💡 (feat) - A new feature (non-breaking change which adds functionality) - [ ] 🔄 (refactor) - Code Refactoring - A code change that neither fixes a bug nor adds a feature - [ ] 🐞 (fix) - Bug Fix (non-breaking change which fixes an issue) - [ ] 🏎 (perf) - Optimization - [x] 📄 (docs) - Documentation - Documentation only changes - [ ] 📄 (test) - Tests - Adding missing tests or correcting existing tests - [ ] ⚙️ (ci) - Continuous Integrations - Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) - [ ] ☑️ (chore) - Chores - Other changes that don't modify src or test files - [ ] ↩️ (revert) - Reverts - Reverts a previous commit(s). <!-- For a timely review/response, please avoid force-pushing additional commits if your PR already received reviews or comments. Before submitting a Pull Request, please ensure you've done the following: - 👷‍♀️ Create small PRs. In most cases this will be possible. - ✅ Provide tests for your changes. - 📝 Use descriptive commit messages (as described below). - 📗 Update any related documentation and include any relevant screenshots. Commit Message Structure (all lower-case): <type>(optional ticket number): <description> [optional body] -->
1 parent fcbae5b commit db214fc

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

CLAUDE.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,65 @@ src/
7575

7676
---
7777

78+
## 🔧 MCP Server Usage Policy
79+
80+
Claude Code may have access to specialized MCP (Model Context Protocol) servers. **Only use MCPs that are available in the current Claude Code instance.** Check tool availability before attempting to use them.
81+
82+
When available, use these MCPs proactively for this project:
83+
84+
### Recommended MCPs for This Project
85+
86+
| MCP Server | When to Use | Project Relevance |
87+
|------------|-------------|-------------------|
88+
| **task-master-ai** | Complex feature planning, PRD parsing, task breakdown | Use instead of TodoWrite for multi-step features |
89+
| **sequential-thinking** | Complex debugging, architectural decisions, multi-step reasoning | React state bugs, Zustand flow issues, component design |
90+
| **context7** | Library documentation lookup | React 18, Zustand, Tailwind CSS, Playwright, Zod, Vite, react-i18next |
91+
| **playwright** | E2E test generation, browser automation, screenshots | Directly integrates with project's Playwright setup |
92+
| **octocode** | GitHub code research, implementation examples | Find patterns for React hooks, Zustand stores, Tailwind components |
93+
| **brave-search** | Error messages, best practices, current solutions | TypeScript errors, React patterns, package issues |
94+
| **filesystem-server** | Read files from other directories | Access parent monorepo files, cross-project references |
95+
| **memory** | Persist architectural decisions, project context | Store integration patterns, component decisions |
96+
97+
### MCP Usage Examples for This Project
98+
99+
```
100+
# Planning a new connection integration
101+
→ task-master-ai: Break down into subtasks (forms, validation, translations, E2E tests)
102+
103+
# Debugging Zustand state not updating
104+
→ sequential-thinking: Trace state flow step-by-step
105+
→ context7: Get Zustand docs for persist/immer middleware
106+
107+
# Creating E2E tests for a new feature
108+
→ playwright: Generate test structure, take screenshots
109+
→ context7: Get Playwright best practices
110+
111+
# Implementing a new React hook
112+
→ octocode: Find similar implementations in popular repos
113+
→ context7: Get React 18 hooks documentation
114+
115+
# Fixing TypeScript errors
116+
→ brave-search: Search specific error message
117+
→ context7: Get TypeScript/Zod documentation
118+
119+
# Understanding parent monorepo structure
120+
→ filesystem-server: Read cross-project and cross-root-directories files
121+
```
122+
123+
### Library Documentation Quick Reference (context7)
124+
125+
Use `context7` with these library IDs for instant documentation:
126+
127+
- React: `/facebook/react`
128+
- Zustand: `/pmndrs/zustand`
129+
- Tailwind CSS: `/tailwindlabs/tailwindcss`
130+
- Playwright: `/microsoft/playwright`
131+
- Zod: `/colinhacks/zod`
132+
- Vite: `/vitejs/vite`
133+
- React Hook Form: `/react-hook-form/react-hook-form`
134+
135+
---
136+
78137
## 🚀 Claude Instructions
79138

80139
### 🤖 Claude System Prompt

0 commit comments

Comments
 (0)