File tree Expand file tree Collapse file tree 1 file changed +33
-0
lines changed Expand file tree Collapse file tree 1 file changed +33
-0
lines changed Original file line number Diff line number Diff line change
1
+ # MCP Inspector Development Guide
2
+
3
+ ## Build Commands
4
+
5
+ - Build all: ` npm run build `
6
+ - Build client: ` npm run build-client `
7
+ - Build server: ` npm run build-server `
8
+ - Development mode: ` npm run dev ` (use ` npm run dev:windows ` on Windows)
9
+ - Format code: ` npm run prettier-fix `
10
+ - Client lint: ` cd client && npm run lint `
11
+
12
+ ## Code Style Guidelines
13
+
14
+ - Use TypeScript with proper type annotations
15
+ - Follow React functional component patterns with hooks
16
+ - Use ES modules (import/export) not CommonJS
17
+ - Use Prettier for formatting (auto-formatted on commit)
18
+ - Follow existing naming conventions:
19
+ - camelCase for variables and functions
20
+ - PascalCase for component names and types
21
+ - kebab-case for file names
22
+ - Use async/await for asynchronous operations
23
+ - Implement proper error handling with try/catch blocks
24
+ - Use Tailwind CSS for styling in the client
25
+ - Keep components small and focused on a single responsibility
26
+
27
+ ## Project Organization
28
+
29
+ The project is organized as a monorepo with workspaces:
30
+
31
+ - ` client/ ` : React frontend with Vite, TypeScript and Tailwind
32
+ - ` server/ ` : Express backend with TypeScript
33
+ - ` bin/ ` : CLI scripts
You can’t perform that action at this time.
0 commit comments