Makefile

# Makefile for mcp-devtools

# Variables
BINARY_NAME=mcp-devtools
BINARY_PATH=bin/$(BINARY_NAME)
GO=go
GOFLAGS=
ifdef TEST_FAST
GOTESTFLAGS=-short
else
GOTESTFLAGS=
endif
GOFMT=$(GO) fmt
GOTEST=$(GO) test
DOCKER=docker
DOCKER_IMAGE=$(BINARY_NAME)

# Default target
.PHONY: all
all: build

# Build the server
.PHONY: build
build:
	mkdir -p bin
	$(GO) build $(GOFLAGS) -o $(BINARY_PATH) \
		-ldflags "-w -s -X main.Version=$(shell git describe --tags --always --dirty 2>/dev/null || echo '0.1.0-dev') \
		-X main.Commit=$(shell git rev-parse --short HEAD 2>/dev/null || echo 'unknown') \
		-X main.BuildDate=$(shell date -u +"%Y-%m-%dT%H:%M:%SZ")" \
		.

# Run the server with stdio transport (default)
.PHONY: run
run: build
	./$(BINARY_PATH)

# Run the server with HTTP transport
.PHONY: run-http
run-http: build
	./$(BINARY_PATH) --transport http --port 18080 --base-url http://localhost

# Run tests (all tests including external dependencies)
# Note: Takes ~10s due to external API calls (npm, crates.io, etc.)
.PHONY: test
test:
	@echo "Running tests (includes external API integration tests, ~10s)..."
	@$(GOTEST) -count=1 $(GOFLAGS) $(GOTESTFLAGS) ./tests/...

# Run fast tests (no external dependencies, ~7s)
.PHONY: test-fast
test-fast:
	@echo "Running fast tests (skips external API integration tests)..."
	@$(GOTEST) -short ./tests/...

# Run tests with detailed per-test timing (shows all tests with time > 0.00s)
.PHONY: test-verbose
test-verbose:
	@echo "Running tests with detailed timing for each test..."
	@$(GOTEST) -count=1 -v $(GOFLAGS) ./tests/... | grep -E "(^=== RUN|^--- PASS|^--- FAIL)" | grep -E "(PASS|FAIL).*[0-9]+\.[0-9]+s" | sed 's/^--- PASS: /  ✓ /' | sed 's/^--- FAIL: /  ✗ /'

# Show slowest tests (useful for optimisation)
.PHONY: test-slow
test-slow:
	@echo "Running tests and showing slowest tests..."
	@$(GOTEST) -count=1 -v $(GOFLAGS) ./tests/... 2>&1 | grep -E "^--- PASS:" | grep -v "(0.00s)" | sed 's/^--- PASS: /  /' | sort -t'(' -k2 -rn

# Benchmark tool token costs
.PHONY: benchmark-tokens
benchmark-tokens:
	@echo "Analysing token costs for all tools..."
	ENABLE_ADDITIONAL_TOOLS=github $(GOTEST) -count=1 -v ./tests/benchmarks -run TestToolTokenCost \
		$(if $(PER_TOOL_MAX),-per-tool-max=$(PER_TOOL_MAX)) \
		$(if $(TOTAL_MAX),-total-max=$(TOTAL_MAX)) \
		$(if $(WARN_THRESHOLD),-warn-threshold=$(WARN_THRESHOLD)) \
		$(if $(LOW_THRESHOLD),-low-threshold=$(LOW_THRESHOLD)) \
		$(if $(HIGH_THRESHOLD),-high-threshold=$(HIGH_THRESHOLD)) \
		$(if $(ALLOW_HIGH_TOKENS),-allow-high-tokens=$(ALLOW_HIGH_TOKENS))

# List all tool definitions as seen by MCP clients
.PHONY: list-tools
list-tools:
	@$(GOTEST) -tags=listtools -count=1 -v ./tests/benchmarks -run TestListTools 2>&1 | sed -n '/^{/,/^}/p' | (command -v jq >/dev/null 2>&1 && jq || cat)

# Run VLM/LLM integration tests (requires external VLM/LLM server configuration)
.PHONY: test-docling-vlm
test-docling-vlm:
	@echo "Running VLM/LLM integration tests..."
	@echo "Note: This requires VLM environment variables to be configured in .env"
	TEST_VLM_INTEGRATION=1 $(GOTEST) -v -run "TestVLMPipeline_ActualIntegration|TestLLMClient_Connectivity|TestMermaidGeneration" ./tests/tools/

# Clean build artefacts
.PHONY: clean
clean:
	rm -rf bin/

# Format code
.PHONY: fmt
fmt:
	$(GOFMT) ./...

# Lint code and check for modernisation opportunities
.PHONY: lint
lint:
	gofmt -w -s .
	golangci-lint run
	go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -fix -test ./...

# Install dependencies
.PHONY: deps
deps:
	$(GO) mod download

# Update dependencies
.PHONY: update-deps
update-deps:
	$(GO) get -u ./...
	$(GO) mod tidy

# Install Python dependencies for document processing
.PHONY: install-docling
install-docling:
	@echo "Installing Python dependencies for document processing..."
	@if command -v python3 >/dev/null 2>&1; then \
		echo "Found python3, installing docling..."; \
		python3 -m pip install --user -U docling; \
	elif command -v python >/dev/null 2>&1; then \
		echo "Found python, installing docling..."; \
		python -m pip install --user -U docling; \
	else \
		echo "Error: Python 3.10+ is required for document processing"; \
		echo "Please install Python 3.10+ and try again"; \
		exit 1; \
	fi
	@echo "Docling installation complete!"

# Check if docling is available
.PHONY: check-docling
check-docling:
	@echo "Checking docling availability..."
	@if command -v python3 >/dev/null 2>&1; then \
		python3 -c "import docling; print('✓ Docling is available')" 2>/dev/null || \
		(echo "✗ Docling not found. Run 'make install-docling' to install it."; exit 1); \
	elif command -v python >/dev/null 2>&1; then \
		python -c "import docling; print('✓ Docling is available')" 2>/dev/null || \
		(echo "✗ Docling not found. Run 'make install-docling' to install it."; exit 1); \
	else \
		echo "✗ Python 3.10+ is required for document processing"; \
		exit 1; \
	fi

# Install all dependencies (Go + Python)
.PHONY: install-all
install-all: deps install-docling
	@echo "All dependencies installed successfully!"

# Run gosec security scans
.PHONY: sec-gosec
sec-gosec:
	gosec -confidence medium -out gosec.out ./...

# Run mcp-scan security scan
.PHONY: sec-mcp-scan
sec-mcp-scan:
	rm -f mcp-scan.out && uvx mcp-scan@latest --opt-out --full-toxic-flows --storage-file .mcp-scan mcp.json > mcp-scan.out && cat mcp-scan.out

# Run semgrep security scan
.PHONY: sec-semgrep
sec-semgrep:
	semgrep --config auto --text --output semgrep.out

# Run safedep vet (vet scan -D .)
.PHONY: sec-safedep-vet
sec-safedep-vet:
# check for the correct vet binary (brew install safedep/tap/vet, not go vet)
	@if ! command -v vet >/dev/null 2>&1; then \
		echo "Error: safedep vet is not installed. Please install it with 'brew install safedep/tap/vet'"; \
		exit 1; \
	fi
	vet scan -D .

.PHONY: sec-performance
sec-performance:
	@echo "Running security utility performance tests..."
	TEST_SECURITY_PERFORMANCE=true $(GOTEST) -v ./tests/tools/ -run="TestSecurityPerformanceComparison" -timeout=30s

# Build Docker image
.PHONY: docker-build
docker-build:
	$(DOCKER) build -t $(DOCKER_IMAGE) .

# Run Docker container
.PHONY: docker-run
docker-run: docker-build
	$(DOCKER) run -p 18080:18080 $(DOCKER_IMAGE)

# Create a new release
.PHONY: release
release:
	@if [ -z "$(VERSION)" ]; then echo "VERSION is required. Use: make release VERSION=x.y.z"; exit 1; fi
	git tag -a v$(VERSION) -m "Release v$(VERSION)"
	git push origin v$(VERSION)

# MCP's inspector tool
.PHONY: inspect
inspect:
	@echo "Running MCP inspector tool..."
	DANGEROUSLY_OMIT_AUTH=true npx -y @modelcontextprotocol/inspector --config mcp.json

# Help target
.PHONY: help
help:
	@echo "Available targets:"
	@echo "  build			: Build the server"
	@echo "  run			: Run the server with stdio transport (default)"
	@echo "  run-http		: Run the server with Streamable HTTP transport"
	@echo "  test 			: Run all tests (including external dependencies)"
	@echo "  test-fast		: Run fast tests (no external dependencies)"
	@echo "  benchmark-tokens	: Analyse token costs for all tools"
	@echo "  list-tools		: List all tool definitions as seen by MCP clients"
	@echo "  test-docling-vlm	: Run VLM/LLM integration tests (requires .env configuration)"
	@echo "  gosec			: Run gosec security tests"
	@echo "  clean			: Clean build artifacts"
	@echo "  fmt			: Format code"
	@echo "  lint			: Lint code and check modernisation"
	@echo "  deps			: Install Go dependencies"
	@echo "  update-deps		: Update Go dependencies"
	@echo "  install-docling	: Install Python dependencies for document processing"
	@echo "  check-docling		: Check if docling is available"
	@echo "  install-all		: Install all dependencies (Go + Python)"
	@echo "  docker-build		: Build Docker image"
	@echo "  docker-run		: Run Docker container with HTTP transport"
	@echo "  release		: Create a new release (requires VERSION=x.y.z)"
	@echo "  sec-gosec		: Run security scan with gosec "
	@echo "  sec-mcp-scan		: Run security scan with mcp-scan"
	@echo "  sec-semgrep		: Run security scan with semgrep"
	@echo "  sec-safedep-vet	: Run security scan with safedep vet"
	@echo "  sec-performance	: Run security utility performance tests"
	@echo "  inspect		: Run MCP's inspector tool"
	@echo "  help			: Show this help message"