sap-abap-mcp

# sap-abap-mcp

[![npm version](https://img.shields.io/npm/v/%40coaspe%2Fsap-abap-mcp)](https://www.npmjs.com/package/@coaspe/sap-abap-mcp)
[![npm downloads](https://img.shields.io/npm/dw/%40coaspe%2Fsap-abap-mcp)](https://www.npmjs.com/package/@coaspe/sap-abap-mcp)
[![MCP Registry](https://img.shields.io/badge/MCP_Registry-io.github.Coaspe-5A45FF)](https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.Coaspe/sap-abap-mcp)
[![license](https://img.shields.io/badge/license-MIT-0A6ED1)](LICENSE)

**The headless, client-neutral, governance-first MCP server for SAP ABAP
development across multiple systems.**

SAP ABAP MCP lets Codex, Claude, and other local MCP hosts work with SAP ABAP
through ABAP Development Tools (ADT) HTTP services. It can inspect and edit
source, run quality checks, manage transports, use abapGit and the RAP
generator, inspect runtime data, compare systems, and perform guarded
refactorings without an IDE runtime, SAP GUI, or an ABAP FS virtual workspace.

## Why this server

SAP now provides an [official ADT MCP
Server](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/configuring-adt-mcp-server-ed94320814734d97801f51a5b6deb802)
inside its ADT clients. This project serves a different operating model:
headless automation from any supported local MCP host.

| | SAP ABAP MCP | SAP ADT MCP Server |
|---|---|---|
| Runtime | Independent local Node.js `stdio` process | Local HTTP server hosted by an ADT client |
| Agent hosts | Codex, Claude, and other local MCP clients | MCP hosts configured against the running ADT server |
| SAP sessions | Multiple named profiles in one process | SAP projects and sessions managed by ADT |
| Guardrails | Production profiles are read-only; writes support package restrictions and explicit confirmations | Governed by the installed ADT version, SAP authorizations, and client configuration |
| Assurance | Read-only transport assessment with JSON, SARIF, and JUnit evidence | SAP-provided in-IDE development workflows |
| Verification | Separates implemented, discovered, authorized, and live-verified capabilities | SAP product support and release documentation |

This is a deployment-model comparison, not a capability benchmark or a claim
of SAP endorsement. Official behavior varies by ADT and SAP backend release.

## 90-second workflow

![Synthetic terminal walkthrough of setup, repository inspection, ABAP Unit and ATC, and transport assessment](assets/demo.gif)

The animation contains synthetic object and transport names and no live SAP
data. See the [accessible transcript and exact workflow](docs/demo-script.md).

## Quick start

You need Node.js 20 or later, network or VPN access to SAP, and an SAP HTTPS URL, three-digit client number, username, and ADT Basic Auth permission.

### 1. Configure SAP

Windows:

```powershell
npx.cmd @coaspe/sap-abap-mcp@latest setup
```

macOS or Linux:

```bash
npx @coaspe/sap-abap-mcp@latest setup
```

The wizard calls the local connection alias `Server name` and the endpoint `SAP URL`. Windows and macOS validate SAP before saving and protect the password with DPAPI or Keychain. Linux saves only non-secret settings and prints the password environment-variable commands to run before starting the MCP client.

### 2. Register the MCP server

After setup, run the command for your client on Windows:

```powershell
codex mcp add sap-abap -- npx.cmd --yes --prefer-online @coaspe/sap-abap-mcp@latest serve --profile DEV100
claude mcp add --transport stdio --scope user sap-abap -- npx.cmd --yes --prefer-online @coaspe/sap-abap-mcp@latest serve --profile DEV100
```

On macOS or Linux, replace `npx.cmd` with `npx`:

```bash
codex mcp add sap-abap -- npx --yes --prefer-online @coaspe/sap-abap-mcp@latest serve --profile DEV100
claude mcp add --transport stdio --scope user sap-abap -- npx --yes --prefer-online @coaspe/sap-abap-mcp@latest serve --profile DEV100
```

Replace `DEV100` with the Server name selected in the wizard. Restart the client, then use `codex mcp list`, `claude mcp get sap-abap`, or `/mcp` to confirm that the process starts. The completed wizard already performs live SAP verification; `/mcp` alone does not prove that SAP authentication succeeded.

Prefer a plugin install? Follow [Claude Code and Codex plugin marketplaces](#claude-code-and-codex-plugin-marketplaces); the included setup skill guides the same local wizard without putting the SAP password in chat. See the detailed [Windows](#detailed-setup-on-windows), [macOS](#detailed-setup-on-macos), and [Linux](#linux-and-containers) sections for platform-specific behavior and server management.

## Community and adoption

- Read the public [roadmap](ROADMAP.md).
- Run or implement the open [SAP ABAP MCP compatibility profile](spec/README.md).
- Add an opt-in, sanitized entry to [ADOPTERS.md](ADOPTERS.md).
- Use [GitHub Discussions](https://github.com/Coaspe/sap-abap-mcp/discussions)
  for implementation questions, compatibility evidence, and RFCs.

Need help evaluating it in a controlled SAP DEV/QAS environment? See the
[professional services and five-day pilot](SERVICES.md). Do not include SAP
credentials, source code, hosts, tokens, or other confidential information in
a public issue or discussion.

### Current v1 surface

The unversioned `serve` command maps the 53 legacy capabilities to 115
action-free v1 tools and seven Resources, split across bounded `core`, `write`,
`analysis`, `debug`, `operations`, and `artifacts` toolsets. Omitting
`--toolsets` selects all 115 tools. Use `--api-version v0` only for legacy
client compatibility, or select toolsets explicitly when a host should
advertise fewer schemas.
Normal clients should omit both `--api-version` and `--toolsets`.

| Invocation | Advertised surface |
|---|---|
| `serve --profile DEV100` | Current v1, all 115 tools and seven Resources |
| `serve --profile DEV100 --toolsets core,analysis` | Selected v1 toolsets only |
| `serve --profile DEV100 --api-version v0` | Legacy 53-tool compatibility surface |

See the
[v1 migration guide](docs/v1-migration.md) for contracts, Resources, and the
separate live-SAP verification boundary.

## ABAP FS parity status

The pinned ABAP FS 2.6.5 source exposes 43 MCP tools. This server provides a strict-compatible subset of 42; the omitted tool is `manage_subagents`, which depends on the VS Code agent host. With 10 headless feature extensions and `read_deferred_result`, this server advertises 53 tools in total.

The first development-parity slice implements BDEF source creation, one-request batch activation, class-runner execution, the ABAP FS REPL contract, and detailed semantic inspection. These SAP-dependent capabilities remain `unverified` until they succeed against the selected live connection; call `get_sap_capabilities` for per-connection evidence.

Snippet execution requires `ZCL_ABAP_REPL` and an active SICF service at `/sap/bc/z_abap_repl`. Generic report/program-console execution is not implemented.

## What it supports

The server provides all 42 strict-compatible headless tools from the pinned ABAP FS baseline, ten grouped feature extensions, and one infrastructure tool for continuing oversized results.

| Area | Capabilities |
|---|---|
| Connections | Multiple SAP profiles, Basic Auth, opt-in OAuth client credentials, lazy login, system metadata, ADT discovery export |
| Repository reads | Search, metadata, source ranges, batch reads, URI reads, source search, enhancements |
| Semantic services | Completion details, definition lookup, documentation, type hierarchy, components, quick-fix discovery, SAP formatter preview |
| Source writes | Exact source replacement, BDEF source creation, syntax diagnostics, single- and one-request batch activation, text elements |
| Refactoring | Rename, package move, extract method, quick-fix application, formatting, deletion |
| Quality | ABAP Unit, ATC, diagnostics, test-include creation |
| Transports | List, details, objects, read-only release assessment, JSON/SARIF/JUnit evidence, compare, create, release, delete, owner/user management, object resolution |
| Versions | Active revision history, revision comparison, inactive source, guarded revision restore |
| abapGit | Repository list, remote information, create, pull, unlink, stage, push, check, branch switch (requires the abapGit ADT backend on the SAP system) |
| RAP | Availability, paged schema, defaults, validation, preview, generation, service binding details, and OData V2/V4 publication and unpublication |
| Runtime | Guarded class-runner and fixed-contract ABAP REPL execution, debugger, breakpoints, stack, variables, dumps, traces, heartbeat checks |
| Cross-system | Source comparison across configured SAP systems |
| Dependency analysis | Bounded where-used dependency graph |
| SAP GUI integration | Validated WebGUI transaction URL generation and optional local launch |
| Data | Read-only ADT SQL queries with bounded or file-based output |
| Artifacts | Mermaid validation/viewer and DOCX test documentation |

The ten grouped extension tools are:

- `inspect_abap_code`
- `refactor_abap_code`
- `manage_abapgit`
- `manage_rap_generator`
- `manage_abap_versions`
- `compare_abap_systems`
- `get_abap_dependency_graph`
- `run_sap_transaction`
- `get_sap_capabilities`
- `run_abap_application`

Grouping related actions keeps the tool-schema footprint lower than exposing every operation as a separate MCP tool.
`read_deferred_result` is the additional infrastructure tool; it reads the remaining UTF-8 chunks of a large result without repeating the SAP operation.

## Transport change assurance

`manage_transport_requests` keeps transport review inside the existing grouped tool. Its read-only `assess_transport` action can run ATC and ABAP Unit for each supported transport object, optionally compare the same objects with a target connection, and emit JSON, SARIF 2.1.0, and JUnit XML reports.

The returned gate is `passed`, `failed`, or `incomplete`. Truncate