vibing-steampunk: Instructions file for GitHub Copilot

Copilot Instructions for vsp

Project

vsp is a Go-native MCP (Model Context Protocol) server that bridges AI agents to SAP ABAP systems via the ADT REST API. Single binary, 6 platforms, zero dependencies. It exposes 81 tools (focused mode) or 122 tools (expert mode) over JSON-RPC/stdio.

Build, Test, Lint

# Build
go build -o vsp ./cmd/vsp

# Run all unit tests
go test ./...

# Run a single test by name
go test -run TestSafetyReadOnly -v ./pkg/adt/

# Run a single package's tests
go test -v ./pkg/cache/

# Integration tests (require live SAP system via SAP_* env vars)
go test -tags=integration -v ./pkg/adt/

# Lint: the CI gate. Correctness linters, issues new since origin/main only
# (.golangci.yml). CI pins golangci-lint v2.13.2 and runs it fail-closed with a
# canary: ./.github/ci/lint.sh gate
golangci-lint run ./...

# Lint debt over the whole tree, advisory (.github/ci/golangci-full.yml)
./.github/ci/lint.sh full

# Size and complexity metrics, as the PR report shows them
make metrics

# Format (gofumpt preferred, falls back to go fmt)
gofumpt -w .

Architecture

cmd/vsp/main.go            → CLI entry point (cobra + viper)
internal/mcp/
  server.go                → MCP server struct, initialization
  tools_register.go        → Tool registration logic (mode + group filtering)
  tools_focused.go         → Focused-mode tool whitelist
  tools_groups.go          → Disableable tool groups (5/U, T, H, D, C, G, R, I, X)
  handlers_*.go            → One file per tool category (20+ handler files)
pkg/adt/
  config.go                → ADT client config (functional options pattern)
  client.go                → Main client facade + read operations
  http.go                  → HTTP transport (CSRF token refresh, session management)
  crud.go                  → Lock → Update → Unlock → Activate lifecycle
  workflows.go             → High-level composite operations (GetSource, WriteSource)
  workflows_edit.go        → EditSource (find-replace with syntax check)
  safety.go                → Operation filtering and package restrictions
  features.go              → Runtime feature probing (auto/on/off)
  debugger.go              → External ABAP debugger (WebSocket via ZADT_VSP)
  xml.go                   → XML type definitions for ADT responses
pkg/dsl/                   → Fluent API for search, test, batch, YAML workflows
pkg/cache/                 → In-memory + SQLite caching
pkg/scripting/             → Lua scripting engine (40+ ADT bindings)