crates-docs CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

A high-performance Rust crate documentation query MCP server. Supports Stdio/HTTP/SSE transport protocols, TinyLFU/TTL memory caching (optional Redis), and provides tools for crate search, documentation lookup, and health checks.

Build & Test Commands

# Build
cargo build
cargo build --release
cargo build --all-features

# Run clippy (both required before merge)
cargo clippy --all-targets -- -D warnings
cargo clippy --all-features --all-targets -- -D warnings

# Format check
cargo fmt -- --check

# Tests (multiple targets - specify correct one)
cargo test --test unit                   # Unit tests (primary)
cargo test --test unit_tests             # Legacy unit tests
cargo test --test integration_tests      # Integration tests
cargo test --test e2e                    # E2E tests

# Single test (must specify target)
cargo test --test unit test_name_here

# Feature-gated tests
cargo test --features cache-redis        # Redis cache tests

# All tests with all features
cargo test --all-features

Feature Flags

Feature	Purpose
default	server, stdio, macros, cache-memory, logging, api-key
cache-redis	Redis distributed cache support
cache-memory	Moka-based memory cache (in default)
hyper-server	HTTP server support
sse	Server-Sent Events transport
streamable-http	Streamable HTTP transport
tls	TLS/SSL support
auth	OAuth authentication

Architecture

src/
├── lib.rs           # Library entry, public API exports
├── main.rs          # Binary entry point
├── cache/           # Cache trait + MemoryCache/RedisCache implementations
├── cli/             # CLI commands (serve, test, config, health)
├── config/          # AppConfig, ServerConfig, CacheConfig, LoggingConfig
├── error/           # Error enum + Result alias
├── server/          # CratesDocsServer, handler, transport modes
├── tools/           # MCP tools (lookup_crate, search_crates, lookup_item, health_check)
│   └── docs/        # DocService, DocCache, HTML parsing
└── utils/           # HTTP client builder, rate limiter