argocd-mcp-server: Instructions file for Claude Code

CLAUDE.md

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

Important Security Rules

NEVER read .env files - These files contain sensitive credentials and authentication tokens. If you need to understand environment variables, refer to the documentation or ask the user directly.

Common Development Commands

Build

go build -o argocd-mcp-server ./cmd/argocd-mcp-server

Run Tests

# Run all tests with gotestsum (default)
make test

# Run basic go tests
go test ./...
make test-basic

# Run tests with verbose output
go test -v ./...
make test-verbose

# Run tests with race detector
go test -race ./...
make test-race

# Run tests with gotestsum (better output)
make test-pretty

# Run tests in watch mode
make test-watch

# Run tests with coverage
go test -cover ./...
make test-cover

# Generate coverage profile and HTML report
make test-coverprofile

# Run tests with gotestsum and coverage HTML report
make test-coverage-pretty

# Run specific package tests
go test ./internal/api/
go test ./internal/argocd/
go test ./internal/argocd/client/
go test ./internal/tools/
go test ./internal/errors/
go test ./internal/grpcwebproxy/
go test ./internal/server/

Linting

# Format code (includes goimports)
make fmt

# Check formatting (includes import formatting)
make fmt-check

# Run go vet
make vet

# Run all linters (fmt-check, vet, staticcheck, golint, ineffassign, misspell)
make lint

# Run basic linters only (fmt-check, vet)
make lint-basic

# Install all linter tools (includes goimports)
make lint-install

# Run advanced linting including security checks (gosec, revive)
make lint-advanced

# Run all quality checks (lint + test)
make check

# Run all checks including advanced linting and race detection
make check-all

Development Setup

# Install dependencies
go mod download
make deps

# Verify dependencies (included in make deps)
go mod verify

# Tidy dependencies
go mod tidy
make tidy