24 lines
1.0 KiB
Markdown
24 lines
1.0 KiB
Markdown
# Claude Helper Guide
|
|
|
|
## Build and Development Commands
|
|
- Format Nix files: `nix fmt`
|
|
- Enter development shell: `nix develop`
|
|
- Check Nix flake: `nix flake check`
|
|
|
|
## Project Structure
|
|
This is a Nix flake that bundles several MCP (Model Control Protocol) servers together for easy consumption. It uses:
|
|
- Node.js for JavaScript-based MCP servers
|
|
- uv for Python package management (for Python-based MCP servers)
|
|
|
|
## Code Style Guidelines
|
|
- **Nix files**: Format with nixpkgs-fmt (available via `nix fmt`)
|
|
- **JavaScript/TypeScript**: Follow standard Node.js conventions
|
|
- **Python**: Use uv for dependency management
|
|
- **Error handling**: Use appropriate error handling for each language
|
|
- **Naming**: Use descriptive, clear names that reflect component purpose
|
|
- **Comments**: Add comments for complex logic or non-obvious implementations
|
|
|
|
## Git Workflow
|
|
- Keep commits small and focused on a single change
|
|
- Write descriptive commit messages explaining the "why" not just the "what"
|
|
- Test changes locally before committing |