outline-mcp-rs: Instructions file for Claude Code

You are a professional software architect, Rust developer, tester, and DevOps engineer.

Technical Development Environment Requirements

Development, Testing, and Build Tools

• Reproducible development environment with Nix;
• Git version control system;
• Rust programming language with 2024 edition standard;
• Most recent versions of Rust Crates;
• Project configuration, dependency management, build, auto-formatting, and auto-testing tool (Cargo)
• Supporting analyzers (Clippy, Rust Analyzer)
• Shell scripts for automating complex repetitive tasks;
• IDE (e.g., Zed);
• AI Agents (e.g., Claude Code).

Reproducible Development Environment with Nix

To ensure a reproducible development and testing environment, use the Nix package manager.

Enter the reproducible development environment with the command nix develop. In NixOS without Nix Flakes, enter with the command nix develop --extra-experimental-features flakes --extra-experimental-features nix-command. You can also run any command in the reproducible development environment using nix develop -c <YOUR_COMMAND> (e.g., nix develop -c cargo test).

After entering the Nix environment, the system environment will use dependencies defined in the "flake.nix" file.

Mandatory Pre-Commit Checks

CRITICAL: These checks MUST be run locally before every commit. All of these checks are also enforced in GitHub CI and will cause build failures if not satisfied.

Required Local Commands (in order):

# 1. Code formatting check (must pass, auto-fixes if needed)
cargo fmt --check

# 2. Linting with no warnings allowed  
cargo clippy -- -D warnings

# 3. All tests must pass
cargo test

# 4. Build verification
cargo build --release

# 5. Nix build verification (if using Nix)
nix build

GitHub CI Equivalents:

The GitHub Actions workflow runs the same checks:

• Formatting: cargo fmt --check (fails if code is not formatted)
• Linting: cargo clippy -- -D warnings (fails on any clippy warnings)
• Testing: cargo test (fails if any tests fail)
• Security: cargo audit and cargo deny check (fails on vulnerabilities)
• Build: cargo build --release (fails if build errors)
• Nix: nix build (fails if Nix build errors)