read-only-local-mysql-mcp-server: Instructions file for Claude Code

TypeScript Coding Rules v3

Type Safety Rules

• No any or as any: Do not use any or type assertions with as any unless the data is truly runtime in nature and cannot be statically typed. When dealing with runtime data, validate it using Yup schemas.
• Explicit function signatures: All functions must have well-defined parameter types and return types.
• Use type over interface: Use type for data shapes and interface only when defining actual contracts/services that may be implemented.

Code Quality Rules

• No code repetition: Repeated code must be extracted into reusable functions.
• Descriptive naming: Use clear, descriptive nmcp-publisher p✓ Successfully published ✓ Server capital.hove/read-only-mysql-mcp-server version 0.1.0ames for variables, functions, and types.
• Prefer const assertions: Use as const for literal types instead of manual type definitions where appropriate.
• No implicit returns: Always explicitly return values from functions.
• Use utility types: Leverage TypeScript utility types (Pick, Omit, Partial, etc.) instead of manual type definitions.

Function Design Rules

• Single responsibility: Functions should handle single actions and be testable in isolation.
• No long functions: Keep functions short and focused. Break complex logic into smaller, composable functions.
• Fail early: Always validate inputs and fail early in functions with clear error messages.

Project Structure Rules

• Shared types separation: Use separate folders/files for shared types that are used across multiple modules.
• Folder organization: Structure code using logical folders (e.g., utils/, shared/, types/, services/).
• Layer separation: Keep the presentation layer separate from the functional/business logic layer.
• Domain grouping: Group related functionality together while maintaining clear boundaries.

TypeScript Configuration Rules (tsconfig.json)

Base Configuration (Required for All Projects)