API

developers.sap.com is a developer site. Everything the browser sees is available as an API — query it, script against it, embed it. Below are the surfaces we publish.

Rate limits & abuse. Anonymous endpoints are best-effort and may be throttled without notice. Authenticated endpoints inherit XSUAA quotas from your service key. Don’t hammer them.

HTTP APIs

Public / anonymous read

No token required. Safe to hit from a browser, a Lambda, or curl on a laptop.

Every OData service also serves $metadata (EDMX / CSDL) at <path>/$metadata — point a code-gen client at that URL and you’re done.

Signed-in developer surface — Tutorial.API scope

For scripting against your own progress + preferences. Requires an XSUAA bearer with the Tutorial.API scope (granted via the Tutorials API Consumer role collection). See Getting a token on the GraphQL page for the OAuth2 auth-code+PKCE and client-credentials flows.

Full endpoint inventory + auth scopes: docs/developers/operations/testing-endpoints.md.

Author / admin surfaces

These exist and are documented, but require elevated XSUAA scopes (Tutorial.Author, Admin, KnowledgeGraph.Admin, SuperAdmin) that are only assigned to internal staff and QA channel authors. If you have the scope and want to script against them, see testing-endpoints.md — surfaces include /admin/* (AdminService), /admin/analytics/* (AnalyticsService, allowlisted SELECT-only SQL), /admin/exports/* (ExportsService), /display/* (DisplayService), /content/publish + /content/rollback (bearer-token content push), /graph/publishConcept + /graph/unpublishConcept, and /author/generateOsVariants.

sap-devs CLI

sap-devs is a companion CLI that bundles the same SAP developer content and context this site consumes — CAP / BTP / ABAP tips, canonical code samples, error lookups, tutorial search, event listings, and more — so you can get to it without leaving your terminal.

Install — the CLI ships as a self-contained binary (it’s no longer published to npm). Pick your platform:

# macOS (Homebrew)
brew tap SAP-samples/sap-devs-cli https://github.com/SAP-samples/sap-devs-cli.git
brew install --cask sap-devs

# Windows (Scoop)
scoop bucket add sap-devs https://github.com/SAP-samples/sap-devs-cli.git
scoop install sap-devs

# Linux / manual — download the archive for your platform from GitHub Releases,
# extract it, and put the binary on your PATH:
# https://github.com/SAP-samples/sap-devs-cli/releases

Then run the first-time setup:

sap-devs init            # first-time setup wizard
sap-devs sync --force    # pull latest content

Common commands

sap-devs tip                             # a quick best-practice reminder
sap-devs errors search "No 'default' database configured"
sap-devs samples search "cap handler"    # canonical code samples
sap-devs tutorial search "cap getting started"
sap-devs tutorial show cap-getting-started
sap-devs news                            # recent SAP Developer News episodes
sap-devs learning search "btp architect" # SAP Learning Journeys
sap-devs discovery services search "hana cloud"
sap-devs doctor                          # tool + project health check
sap-devs help                            # full command list

The full command reference lives with the CLI itself: run sap-devs help or see the sap-devs project repository.

MCP server

There are two MCP surfaces here, and they’re different things:

1. The hosted MCP server — served by this site over HTTP, so an AI client can search tutorials, read missions, query the knowledge graph, and (signed in) read your progress. No SDK, no scraping.
2. The sap-devs CLI MCP — a local stdio server bundled with the sap-devs CLI that exposes SAP developer knowledge (tips, samples, error lookups) to your agent.

Hosted MCP (over HTTP)

Each CDS service is mounted separately under /mcp/* over the Model Context Protocol Streamable HTTP transport. There is no aggregate /mcp root — point your client at the specific service you want.

describe and query are auto-generated on every mount. The /mcp/graph mount additionally exposes MCP resources (tutorial://<slug>, mission://<slug>, concept://<id>) and prompt templates (prompts/list).

Anonymous read — just point a Streamable-HTTP client at the mount. Claude Code:

{
  "mcpServers": {
    "sap-developers-search": { "type": "http", "url": "https://developers.sap.com/mcp/search" },
    "sap-developers-graph":  { "type": "http", "url": "https://developers.sap.com/mcp/graph" }
  }
}

Signed-in tools (your progress, recommendations, marking steps done) live behind two authenticated tiers:

• /mcp-auth/* — OAuth 2.1 + PKCE. Requires the Tutorial.MCP scope (Tutorials MCP Users role collection). XSUAA has no dynamic client registration, so bridge through mcp-remote with the pre-registered public client.
• /mcp-pat/* — a Personal Access Token for headless / CI clients that can’t do a browser flow. Mint one at /me/tokens/ (self-service; requires the Tutorials MCP Users role collection), then send Authorization: Bearer pat_.... Scopes: read (read tools) or write (also allows complete_step / reset_tutorial_progress). The plaintext token is shown once.

Full connection walkthrough (Claude Desktop, Claude Code, mcp-remote, PATs, troubleshooting): MCP Quickstart. Tool + parameter reference: mcp-server.md.

Local sap-devs CLI MCP (over stdio)

sap-devs mcp serve starts a Model Context Protocol server on stdio that exposes SAP developer knowledge as tools to AI agents (Claude Code, Cursor, Windsurf, and anything else that speaks MCP). This is unrelated to the hosted server above — it ships with the CLI and runs on your machine.

Available tools — list_packs, get_context, get_tip, search_resources, get_known_errors, get_recent_news, get_news_detail, search_tutorials, search_learning_journeys, get_samples, check_tools, check_project, search_events, search_videos, search_discovery, plus cf_* / btp_* inspection tools that surface your local Cloud Foundry and BTP state to the agent.

Claude Code

claude mcp add sap-devs-server -- sap-devs mcp serve

Cursor / Windsurf — add to your MCP settings JSON:

{
  "mcpServers": {
    "sap-devs-server": { "command": "sap-devs", "args": ["mcp", "serve"] }
  }
}

Once connected, ask your agent “what’s new in SAP” or paste an SAP error and it will resolve against the live content instead of stale training data.

A2A agent

Alongside the MCP server, this site exposes a first-party A2A protocol agent — so a central SAP Joule instance (or another trusted BTP integration) can consume the platform’s Joule capabilities agent-to-agent, without going through MCP. Same brain as the site’s own Joule; different wire protocol.

MCP and A2A are complementary, not alternatives:

• MCP exposes discrete tools an AI client calls directly (search, graph, your progress). Good for a client that wants to orchestrate the tools itself.
• A2A exposes the platform as a single agent with named skills. A calling agent hands over a natural-language task and gets back a completed A2A Task (or a stream of events) — the platform runs its own agentic loop internally.

Discovery

The Agent Card is public — no token:

curl <base>/.well-known/agent-card.json

It advertises the endpoint URL, security scheme, streaming capability, and the five skills below, and links its own consumption guide at <base>/.well-known/a2a-instructions.md. When A2A is disabled by an admin, the card sets metadata.available: false and POST /a2a returns HTTP 503.

Transport

JSON-RPC 2.0 over POST <base>/a2a. Synchronous message/send returns a completed Task with results in result.artifacts; message/stream returns an SSE event stream (used by tutorial-chat). tasks/get and tasks/cancel operate on a task id.

curl -X POST <base>/a2a \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"message/send",
       "params":{"message":{"role":"user","parts":[{"kind":"text","text":"Find CAP tutorials"}]},
                 "metadata":{"skillId":"search-tutorials"}}}'

Auth

Every /a2a call needs an XSUAA bearer carrying the Tutorial.MCP scope, obtained via OAuth2 client-credentials against the tokenUrl in the card’s securitySchemes.xsuaa. This is a machine-to-machine flow — there is no self-service PAT/PKCE path like the MCP signed-in tools. The Agent Card itself is public; user-progress additionally needs the end-user’s identity forwarded.

Full connection walkthrough (public probe, client-credentials, streaming, errors, Joule wiring): A2A Quickstart. Canonical served guide: /.well-known/a2a-instructions.md.

Feeds

Reference documentation

These docs are written for the internal team. They’re public because the repo is public. They can change without notice and aren’t part of any supported contract.

Curated pointers into the developer docs that a curious integrator might find useful:

• Homepage architecture — how the verb spine and homepage shelves are wired.
• Build pipeline — how tutorials flow from the sap-tutorials GitHub org into Hugo + HANA.
• Testing endpoints — canonical inventory of every UI + API surface with auth scopes.
• Rebuild-content workflow — how content gets republished to HANA.
• HCQL protocol adapter — CAP 10’s Hybrid CQN adapter, enabled on the read-heavy services above.

Feedback & contributions

Bug or gap? Open an issue on the tutorials-ims repo. PRs welcome.

Devtoberfest Scavenger Hunt