Skip to content

AGENTS.md

Latest commit

 

History

History
53 lines (41 loc) · 2.14 KB

AGENTS.md

File metadata and controls

53 lines (41 loc) · 2.14 KB
Raw

Repository guidance

LeanToken is a Rust application and library providing token-bounded repository retrieval through CLI and MCP adapters.

Architecture

  • Services owns application behavior; CLI and MCP adapters remain thin.
  • Preserve deterministic ranking, exact token budgets, bounded memory, atomic SQLite generations, and request snapshot consistency.
  • Document new scan, fan-out, storage, and concurrency bounds in docs/architecture.md.

Development

Run focused tests while iterating. Before the first push, format the tree and run the smallest relevant check or behavioral test that proves the change. Do not block opening a pull request on the complete CI-equivalent suite. Use cargo test-focused <module-or-test> to filter the library, binary, and integration targets, and use the ownership map in docs/development.md when choosing affected tests.

GitHub Actions owns normal Rust merge readiness and must pass:

cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test-product

It also runs cargo test-extras for examples and benchmark behavior and checks rustdoc for public APIs and documentation. Run a complete gate locally only when reproducing CI, working without CI, or changing the gate itself. See docs/development.md for the complete development, packaging, and release workflow.

Change-specific validation

  • For performance or scalability work, use $optimize-accuracy-first.
  • For storage changes, include query-plan evidence and focused integration tests; a faster microbenchmark does not justify weaker atomicity, limits, freshness, or deterministic results.
  • Treat MCP schema snapshots as protocol changes. Inspect the schema diff before accepting an insta update.
  • Prefer behavioral integration tests for observable contracts and unit tests for private invariants.
  • Match surrounding Rust naming, documentation, and comment conventions.

Contributions

Use conventional commit prefixes and follow .github/pull_request_template.md. For releases and npm publication, follow docs/development.md and docs/releases.md; never replace an already-published version.