SAP CAP Node.js Development Skill
1. Scope guardrails (read first, every time)
Before doing anything, classify the request:
- CAP Node.js development? → proceed.
- UI / frontend work? → refuse: "This skill is SAP CAP Node.js only. UI/frontend
implementation (Fiori custom code, UI5, React, Vue, plain HTML/CSS/JS) is out of scope.
CAP-side UI annotations in
.cds are in scope; the UI app itself is not."
- Backend in another language or stack? → refuse: "This skill is SAP CAP Node.js only.
Java CAP, Spring, plain Node/Express, NestJS, Python, Go, .NET, and non-CAP microservices
are out of scope."
- Non-CAP architecture (custom OData/REST/GraphQL outside CAP)? → refuse with the same
message. CAP must be the framework (
@sap/cds + cds.ApplicationService, or documented
@cap-js/* plugins).
- Uses a private / protected / deprecated API? → refuse and propose the documented public
alternative. If none exists, say so and stop.
When in doubt, ask the user to confirm the request fits the CAP Node.js scope before writing code.
2. Public-API rule
- Only import from documented, stable entry points:
@sap/cds, @sap/cds/common,
@cap-js/sqlite, @cap-js/hana, @cap-js/postgres, @cap-js/attachments,
@cap-js/audit-logging, @cap-js/change-tracking, @cap-js/telemetry, @cap-js/graphql,
@cap-js/mcp-server, @sap/cds-mtxs.
- Never reach into
@sap/cds/lib/*, node_modules/@sap/cds/lib/*, or any path the docs do not
describe.
- Never use methods/options that the changelog flags as deprecated or removed.
- Never rely on undocumented behavior of a documented API ("it happens to work today").
- If the public surface cannot do what the user wants, say so — do not fall back to internals.
3. Domain-first / Less code → Less mistakes
"Every line of code not written is free of errors." — SAP Capire
https://cap.cloud.sap/docs/get-started/features#less-code-%E2%86%92-less-mistakes
CAP captures domain knowledge and intent declaratively ("What, not How"). This skill
follows that principle: prefer the CDS model, annotations, projections, and CAP's generic
providers over hand-written handlers and SQL.
CAP's generic providers already handle: CRUD, nested documents, drafts, media, search,
pagination, sorting, authentication / authorization, localization, input validation,
auto-generated keys, concurrency control. Do not re-implement these in code.
Decision order when adding a new behavior — only drop to the next step if the previous one
cannot express it:
- Schema — types, associations, compositions, aspects from
@sap/cds/common.
- Annotations —
@mandatory, @assert.*, @readonly, @insertonly, @requires,
@restrict, @cds.persistence.*, @cds.search, @odata.draft.enabled, @odata.etag,
@UI.*.
- Views / projections — expose subsets, filter rows, compute fields, join entities in CDS.
- Status Flows — when the behavior is a state machine (row walks through named states),
use
@flow.status + @from + @to. CAP validates the entry state and writes the target
state. See references/status-flow.md. ⚠ Currently Gamma in
capire — only adopt with explicit team acceptance.
- CAP plugins —
@cap-js/attachments, @cap-js/audit-logging, @cap-js/change-tracking,
@cap-js/telemetry, @cap-js/graphql, etc.
- Concurrency control —
@odata.etag (via managed.modifiedAt) for optimistic locking;
cds.tx(req) with .forUpdate() on the base entity when invariants span multiple rows.
See references/concurrency-control.md and
references/race-conditions.md.
- Event handlers (last resort) — only for behavior that is genuinely business logic and
cannot be expressed declaratively by steps 1–6. Never re-implement what
@from/@to,
@odata.etag, @assert.*, @requires, or a projection already does for free.
Full explanation, examples, and the "is this PR domain-first?" checklist:
references/domain-first.md.
4. Where to put what
| Concern |
Where it lives |
| Keys, types, relationships |
db/schema.cds |
| Required / range / format / unique |
CDS @mandatory, @assert.* |
| Computed fields |
CDS calculated elements (= expr, stored) |
| Exposed subset / filtered rows |
srv/*.cds projection |
| Joins across entities |
CDS view (as select from … join …) |
| Authorization (who can do what) |
@requires, @restrict |
| Fiori UI shape |
@UI.*, @Common.* annotations in CDS |
| i18n texts |
_i18n/ .properties files |
| Seed / reference data |
CSV in db/data/ |
| Cross-cutting concerns |
@cap-js/* plugin (configured, not coded) |
| Genuine business logic |
Node.js event handler in srv/*.js |
The app/ folder (UI applications) is out of scope for this skill.
5. Project structure
project/
├── app/ # UI content ← out of scope
├── srv/ # Service definitions (.cds, .js/.ts) ← in scope
├── db/ # Data models, views, seed data ← in scope
│ ├── schema.cds
│ └── data/
├── package.json # Dependencies + CDS config ← in scope
└── .cdsrc.json # CDS configuration (optional)
6. Quick start (minimal)
npm i -g @sap/cds-dk @sap/cds-lsp
cds init <project-name>
cds watch
Add capabilities as needed (cds add hana | sqlite | xsuaa | mta | multitenancy | typescript).
Full CLI reference: references/cli-complete.md and
references/tools-complete.md.
Domain-first starter — model first, expose with a projection, no handler needed:
// db/schema.cds
using { cuid, managed } from '@sap/cds/common';
namespace my.bookshop;
entity Books : cuid, managed {
title : String(111) @mandatory;
stock : Integer @assert.range: [0, 99999];
price : Decimal(9,2);
}
// srv/catalog-service.cds
using { my.bookshop as my } from '../db/schema';
@requires: 'authenticated-user'
service CatalogService {
@readonly entity Books as projection on my.Books where stock > 0;
}
That's a working, validated, authorized, searchable OData service — zero JS.
For more entity / projection / view / annotation patterns, see the templates folder and the
references below.
7. MCP integration
The skill integrates with the official CAP MCP server, giving the agent live access to the
project's compiled CSN model and CAP docs:
search_model — fuzzy search entities, services, actions, and relationships in the CSN.
search_docs — semantic search through CAP documentation.
Setup: references/mcp-integration.md.
Use cases: references/mcp-use-cases.md.
8. Bundled resources (index)
Philosophy & rules
- domain-first.md — "Less code → less mistakes", decision order,
annotations and views to prefer over code, anti-patterns.
- best-practices.md — full DO / DON'T, code smells, review
checklist.
- security-audit.md — audit matrix against the AI-agent /
supply-chain attack surface (prompt injection, MCP poisoning, supply chain, eval,
SSRF, credential leakage, etc.) and the standing rules the skill enforces on agent output.
Language & query
- cdl-syntax.md — CDL syntax reference.
- annotations-reference.md — annotations catalog.
- cql-queries.md — CQL basics.
- cql-patterns.md — CQL usage patterns.
- csn-cqn-cxn.md — Core Schema Notation and query APIs.
- sql-injection.md — why CAP's CQL prevents injection, when raw
SQL is allowed, identifier allow-lists.
State, concurrency & safety
- status-flow.md —
@flow.status + @from + @to for
state-machine use cases (capire Gamma).
- concurrency-control.md —
@odata.etag optimistic
locking, .forUpdate() pessimistic locking, draft serialization.
- race-conditions.md — TOCTOU, transactions, bootstrap
races, event-consumer idempotency.
Runtime & handlers (use sparingly — model first)
- nodejs-runtime.md — Node.js runtime reference.
- event-handlers-nodejs.md — handler patterns.
- event-handlers-patterns.md — extended patterns.
- service-definitions.md — service definition patterns.
Persistence
- databases.md — DB configuration.
- data-privacy-security.md — GDPR, security.
- localization-temporal.md — i18n (UI bundle
i18n.properties and error-message bundle messages.properties for req.error / req.reject, built-in keys ASSERT_MANDATORY, ASSERT_RANGE, ASSERT_FORMAT, ASSERT_TARGET, MULTIPLE_ERRORS), temporal data.
Integration & deployment
- consuming-services-deployment.md — remote
services, bindings, deployment.
- deployment-cf.md — Cloud Foundry deployment details.
- extensibility-multitenancy.md — SaaS / MTX.
- plugins-reference.md —
@cap-js/* plugins.
- fiori-integration.md — CAP-side UI annotations only.
Tooling
- cli-complete.md —
cds CLI reference.
- tools-complete.md — full tooling overview.
- mcp-integration.md — CAP MCP server.
- mcp-use-cases.md — MCP scenarios.
- CAP_Troubleshooting.md — troubleshooting.
Templates
- templates/bookshop-schema.cds — data model example.
- templates/catalog-service.cds — service definition.
- templates/fiori-annotations.cds — UI annotations (CDS only).
- templates/mta.yaml — MTA descriptor.
- templates/package.json — project config.
- templates/service-handler.js — Node.js handler (use sparingly).
- templates/service-handler.ts — TypeScript handler.
- templates/xs-security.json — XSUAA security config.
9. Quick links
10. Version
- Skill Version: 3.1.0
- Runtime: Node.js only
- CAP Version: @sap/cds 9.7.x
- MCP Version: @cap-js/mcp-server 0.0.3+
- LSP Version: @sap/cds-lsp 9.7.x
- Last Verified: 2026-05-12
- License: GPL-3.0
Source: Fab2295/sap-skills — distributed by TomeVault.
1---2name: fab2295-sap-skills-sap-cap-nodejs-dev3description: SAP CAP Node.js Development Skill4---56# SAP CAP Node.js Development Skill78## 1. Scope guardrails (read first, every time)910Before doing anything, classify the request:11121. **CAP Node.js development?** → proceed.132. **UI / frontend work?** → refuse: "This skill is SAP CAP Node.js only. UI/frontend14 implementation (Fiori custom code, UI5, React, Vue, plain HTML/CSS/JS) is out of scope.15 CAP-side UI *annotations* in `.cds` are in scope; the UI app itself is not."163. **Backend in another language or stack?** → refuse: "This skill is SAP CAP Node.js only.17 Java CAP, Spring, plain Node/Express, NestJS, Python, Go, .NET, and non-CAP microservices18 are out of scope."194. **Non-CAP architecture (custom OData/REST/GraphQL outside CAP)?** → refuse with the same20 message. CAP must be the framework (`@sap/cds` + `cds.ApplicationService`, or documented21 `@cap-js/*` plugins).225. **Uses a private / protected / deprecated API?** → refuse and propose the documented public23 alternative. If none exists, say so and stop.2425When in doubt, ask the user to confirm the request fits the CAP Node.js scope before writing code.2627## 2. Public-API rule2829- Only import from documented, stable entry points: `@sap/cds`, `@sap/cds/common`,30 `@cap-js/sqlite`, `@cap-js/hana`, `@cap-js/postgres`, `@cap-js/attachments`,31 `@cap-js/audit-logging`, `@cap-js/change-tracking`, `@cap-js/telemetry`, `@cap-js/graphql`,32 `@cap-js/mcp-server`, `@sap/cds-mtxs`.33- Never reach into `@sap/cds/lib/*`, `node_modules/@sap/cds/lib/*`, or any path the docs do not34 describe.35- Never use methods/options that the changelog flags as **deprecated** or **removed**.36- Never rely on undocumented behavior of a documented API ("it happens to work today").37- If the public surface cannot do what the user wants, say so — do not fall back to internals.3839## 3. Domain-first / Less code → Less mistakes4041> "Every line of code not written is free of errors." — SAP Capire42> https://cap.cloud.sap/docs/get-started/features#less-code-%E2%86%92-less-mistakes4344CAP captures **domain knowledge and intent declaratively** ("What, not How"). This skill45follows that principle: prefer the CDS model, annotations, projections, and CAP's generic46providers over hand-written handlers and SQL.4748**CAP's generic providers already handle**: CRUD, nested documents, drafts, media, search,49pagination, sorting, authentication / authorization, localization, input validation,50auto-generated keys, concurrency control. **Do not re-implement these in code.**5152**Decision order** when adding a new behavior — only drop to the next step if the previous one53cannot express it:54551. **Schema** — types, associations, compositions, aspects from `@sap/cds/common`.562. **Annotations** — `@mandatory`, `@assert.*`, `@readonly`, `@insertonly`, `@requires`,57 `@restrict`, `@cds.persistence.*`, `@cds.search`, `@odata.draft.enabled`, `@odata.etag`,58 `@UI.*`.593. **Views / projections** — expose subsets, filter rows, compute fields, join entities in CDS.604. **Status Flows** — when the behavior is a state machine (row walks through named states),61 use `@flow.status` + `@from` + `@to`. CAP validates the entry state and writes the target62 state. See [references/status-flow.md](references/status-flow.md). ⚠ Currently Gamma in63 capire — only adopt with explicit team acceptance.645. **CAP plugins** — `@cap-js/attachments`, `@cap-js/audit-logging`, `@cap-js/change-tracking`,65 `@cap-js/telemetry`, `@cap-js/graphql`, etc.666. **Concurrency control** — `@odata.etag` (via `managed.modifiedAt`) for optimistic locking;67 `cds.tx(req)` with `.forUpdate()` on the base entity when invariants span multiple rows.68 See [references/concurrency-control.md](references/concurrency-control.md) and69 [references/race-conditions.md](references/race-conditions.md).707. **Event handlers** (last resort) — only for behavior that is genuinely business logic and71 cannot be expressed declaratively by steps 1–6. Never re-implement what `@from`/`@to`,72 `@odata.etag`, `@assert.*`, `@requires`, or a projection already does for free.7374Full explanation, examples, and the "is this PR domain-first?" checklist:75[references/domain-first.md](references/domain-first.md).7677## 4. Where to put what7879| Concern | Where it lives |80|--------------------------------------|--------------------------------------------------|81| Keys, types, relationships | `db/schema.cds` |82| Required / range / format / unique | CDS `@mandatory`, `@assert.*` |83| Computed fields | CDS calculated elements (`= expr`, `stored`) |84| Exposed subset / filtered rows | `srv/*.cds` projection |85| Joins across entities | CDS view (`as select from … join …`) |86| Authorization (who can do what) | `@requires`, `@restrict` |87| Fiori UI shape | `@UI.*`, `@Common.*` annotations in CDS |88| i18n texts | `_i18n/` `.properties` files |89| Seed / reference data | CSV in `db/data/` |90| Cross-cutting concerns | `@cap-js/*` plugin (configured, not coded) |91| Genuine business logic | Node.js event handler in `srv/*.js` |9293The `app/` folder (UI applications) is **out of scope** for this skill.9495## 5. Project structure9697```98project/99├── app/ # UI content ← out of scope100├── srv/ # Service definitions (.cds, .js/.ts) ← in scope101├── db/ # Data models, views, seed data ← in scope102│ ├── schema.cds103│ └── data/104├── package.json # Dependencies + CDS config ← in scope105└── .cdsrc.json # CDS configuration (optional)106```107108## 6. Quick start (minimal)109110```sh111npm i -g @sap/cds-dk @sap/cds-lsp112cds init <project-name>113cds watch114```115116Add capabilities as needed (`cds add hana | sqlite | xsuaa | mta | multitenancy | typescript`).117Full CLI reference: [references/cli-complete.md](references/cli-complete.md) and118[references/tools-complete.md](references/tools-complete.md).119120**Domain-first starter** — model first, expose with a projection, no handler needed:121122```cds123// db/schema.cds124using { cuid, managed } from '@sap/cds/common';125namespace my.bookshop;126127entity Books : cuid, managed {128 title : String(111) @mandatory;129 stock : Integer @assert.range: [0, 99999];130 price : Decimal(9,2);131}132```133134```cds135// srv/catalog-service.cds136using { my.bookshop as my } from '../db/schema';137138@requires: 'authenticated-user'139service CatalogService {140 @readonly entity Books as projection on my.Books where stock > 0;141}142```143144That's a working, validated, authorized, searchable OData service — zero JS.145146For more entity / projection / view / annotation patterns, see the templates folder and the147references below.148149## 7. MCP integration150151The skill integrates with the official CAP MCP server, giving the agent live access to the152project's compiled CSN model and CAP docs:153154- `search_model` — fuzzy search entities, services, actions, and relationships in the CSN.155- `search_docs` — semantic search through CAP documentation.156157Setup: [references/mcp-integration.md](references/mcp-integration.md).158Use cases: [references/mcp-use-cases.md](references/mcp-use-cases.md).159160## 8. Bundled resources (index)161162### Philosophy & rules163- [domain-first.md](references/domain-first.md) — "Less code → less mistakes", decision order,164 annotations and views to prefer over code, anti-patterns.165- [best-practices.md](references/best-practices.md) — full DO / DON'T, code smells, review166 checklist.167- [security-audit.md](references/security-audit.md) — audit matrix against the AI-agent /168 supply-chain attack surface (prompt injection, MCP poisoning, supply chain, eval,169 SSRF, credential leakage, etc.) and the standing rules the skill enforces on agent output.170171### Language & query172- [cdl-syntax.md](references/cdl-syntax.md) — CDL syntax reference.173- [annotations-reference.md](references/annotations-reference.md) — annotations catalog.174- [cql-queries.md](references/cql-queries.md) — CQL basics.175- [cql-patterns.md](references/cql-patterns.md) — CQL usage patterns.176- [csn-cqn-cxn.md](references/csn-cqn-cxn.md) — Core Schema Notation and query APIs.177- [sql-injection.md](references/sql-injection.md) — why CAP's CQL prevents injection, when raw178 SQL is allowed, identifier allow-lists.179180### State, concurrency & safety181- [status-flow.md](references/status-flow.md) — `@flow.status` + `@from` + `@to` for182 state-machine use cases (capire Gamma).183- [concurrency-control.md](references/concurrency-control.md) — `@odata.etag` optimistic184 locking, `.forUpdate()` pessimistic locking, draft serialization.185- [race-conditions.md](references/race-conditions.md) — TOCTOU, transactions, bootstrap186 races, event-consumer idempotency.187188### Runtime & handlers (use sparingly — model first)189- [nodejs-runtime.md](references/nodejs-runtime.md) — Node.js runtime reference.190- [event-handlers-nodejs.md](references/event-handlers-nodejs.md) — handler patterns.191- [event-handlers-patterns.md](references/event-handlers-patterns.md) — extended patterns.192- [service-definitions.md](references/service-definitions.md) — service definition patterns.193194### Persistence195- [databases.md](references/databases.md) — DB configuration.196- [data-privacy-security.md](references/data-privacy-security.md) — GDPR, security.197- [localization-temporal.md](references/localization-temporal.md) — i18n (UI bundle `i18n.properties` and **error-message bundle `messages.properties`** for `req.error` / `req.reject`, built-in keys `ASSERT_MANDATORY`, `ASSERT_RANGE`, `ASSERT_FORMAT`, `ASSERT_TARGET`, `MULTIPLE_ERRORS`), temporal data.198199### Integration & deployment200- [consuming-services-deployment.md](references/consuming-services-deployment.md) — remote201 services, bindings, deployment.202- [deployment-cf.md](references/deployment-cf.md) — Cloud Foundry deployment details.203- [extensibility-multitenancy.md](references/extensibility-multitenancy.md) — SaaS / MTX.204- [plugins-reference.md](references/plugins-reference.md) — `@cap-js/*` plugins.205- [fiori-integration.md](references/fiori-integration.md) — CAP-side UI annotations only.206207### Tooling208- [cli-complete.md](references/cli-complete.md) — `cds` CLI reference.209- [tools-complete.md](references/tools-complete.md) — full tooling overview.210- [mcp-integration.md](references/mcp-integration.md) — CAP MCP server.211- [mcp-use-cases.md](references/mcp-use-cases.md) — MCP scenarios.212- [CAP_Troubleshooting.md](references/CAP_Troubleshooting.md) — troubleshooting.213214### Templates215- [templates/bookshop-schema.cds](templates/bookshop-schema.cds) — data model example.216- [templates/catalog-service.cds](templates/catalog-service.cds) — service definition.217- [templates/fiori-annotations.cds](templates/fiori-annotations.cds) — UI annotations (CDS only).218- [templates/mta.yaml](templates/mta.yaml) — MTA descriptor.219- [templates/package.json](templates/package.json) — project config.220- [templates/service-handler.js](templates/service-handler.js) — Node.js handler (use sparingly).221- [templates/service-handler.ts](templates/service-handler.ts) — TypeScript handler.222- [templates/xs-security.json](templates/xs-security.json) — XSUAA security config.223224## 9. Quick links225226- CAP Documentation: https://cap.cloud.sap/docs/227- CDS Language: https://cap.cloud.sap/docs/cds/228- Node.js Runtime: https://cap.cloud.sap/docs/node.js/229- Best Practices (official): https://cap.cloud.sap/docs/about/best-practices230- GitHub: https://github.com/cap-js/docs231232## 10. Version233234- Skill Version: 3.1.0235- Runtime: Node.js only236- CAP Version: @sap/cds 9.7.x237- MCP Version: @cap-js/mcp-server 0.0.3+238- LSP Version: @sap/cds-lsp 9.7.x239- Last Verified: 2026-05-12240- License: GPL-3.0241242---243> Source: [Fab2295/sap-skills](https://github.com/Fab2295/sap-skills) — distributed by [TomeVault](https://tomevault.io).244<!-- tomevault:4.0:skill_md:2026-05-15 -->