@cap-js/agents 0.0.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +155 -0
  3. package/_i18n/messages.properties +31 -0
  4. package/cds-plugin.js +140 -0
  5. package/index.cds +105 -0
  6. package/index.js +0 -0
  7. package/lib/agents/markdown/backends/mime-utils.js +37 -0
  8. package/lib/agents/markdown/backends/outputs-backend.js +152 -0
  9. package/lib/agents/markdown/backends/uploads-backend.js +143 -0
  10. package/lib/agents/markdown/deep-agent.js +93 -0
  11. package/lib/agents/middleware/agent-actions.js +18 -0
  12. package/lib/agents/middleware/content-filter.js +191 -0
  13. package/lib/agents/middleware/hitl-edit-note-injector.js +18 -0
  14. package/lib/agents/middleware/hitl.js +20 -0
  15. package/lib/agents/middleware/index.js +19 -0
  16. package/lib/agents/middleware/patch-tool-calls.js +51 -0
  17. package/lib/agents/middleware/quota-enforcer.js +94 -0
  18. package/lib/agents/middleware/status-update.js +153 -0
  19. package/lib/agents/middleware/tool-selection.js +22 -0
  20. package/lib/agents/quota-enforcer-at-start.js +198 -0
  21. package/lib/agents/summarize-on-timeout.js +91 -0
  22. package/lib/compile.js +55 -0
  23. package/lib/index.cjs +1 -0
  24. package/lib/index.js +422 -0
  25. package/lib/models/aicore.js +441 -0
  26. package/lib/models/anthropic.js +77 -0
  27. package/lib/models/mock.js +88 -0
  28. package/lib/preview/chat.html +875 -0
  29. package/lib/preview/preview.js +46 -0
  30. package/lib/protocol/agent-card.js +297 -0
  31. package/lib/protocol/persistence/checkpoint-saver.js +317 -0
  32. package/lib/protocol/persistence/file-store.js +209 -0
  33. package/lib/protocol/persistence/push-notification-store.js +59 -0
  34. package/lib/protocol/persistence/task-store.js +47 -0
  35. package/lib/protocol/push-notification-sender.js +57 -0
  36. package/lib/sidecar.js +162 -0
  37. package/lib/telemetry/active-users.js +106 -0
  38. package/lib/telemetry/chat-tracing.js +342 -0
  39. package/lib/telemetry/metrics.js +85 -0
  40. package/lib/telemetry/mlflow.js +290 -0
  41. package/lib/telemetry/tool-tracing.js +164 -0
  42. package/lib/telemetry/tracing.js +150 -0
  43. package/lib/utils/inner-auth.js +33 -0
  44. package/lib/utils/markdown.js +199 -0
  45. package/lib/utils/message-handling.js +155 -0
  46. package/lib/utils/utils.js +168 -0
  47. package/package.json +225 -2
  48. package/srv/graph-cache.js +82 -0
  49. package/srv/handlers/graph-executor.js +1369 -0
  50. package/srv/handlers/index.js +173 -0
  51. package/srv/handlers/mcp-tools.js +159 -0
  52. package/srv/handlers/sub-agent-tools.js +314 -0
  53. package/srv/handlers/system-prompt.js +25 -0
  54. package/srv/handlers/tools.js +366 -0
  55. package/srv/langgraph-executor-srv.js +70 -0
  56. package/srv/push-notification-srv.js +149 -0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 SAP SE
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,155 @@
1
+ [![REUSE status](https://api.reuse.software/badge/github.com/cap-js/agents)](https://api.reuse.software/info/github.com/cap-js/agents)
2
+
3
+ # SAP Cloud Application Programming Model, agent development plugin for Node.js
4
+
5
+ ## About this project
6
+
7
+ CDS plugin for building agents based on the [A2A](https://a2a-protocol.org) protocol.
8
+
9
+ ## Requirements and Setup
10
+
11
+ We use the [@capire/bookshop](https://github.com/capire/bookshop) as a running sample hereinafter. Clone it and open it in VSCode as follows:
12
+
13
+ ```bash
14
+ git clone https://github.com/capire/bookshop
15
+ code bookshop
16
+ ```
17
+
18
+ Within your project root run this to add the plugin:
19
+
20
+ ```bash
21
+ npm add @cap-js/agents
22
+ ```
23
+
24
+ Annotate the `CatalogService` with `@agent`:
25
+
26
+ ```cds
27
+ // srv/cat-service.cds
28
+ ...
29
+ annotate CatalogService with @agent;
30
+ ```
31
+
32
+ Start your server with `cds watch` and note that the A2A protocol gets served:
33
+
34
+ ```bash
35
+ [cds] - serving CatalogService {
36
+ at: [ ..., '/a2a/browse' ],
37
+ ...
38
+ }
39
+ ```
40
+
41
+ For local development, the plugin serves a chat preview at `http://localhost:4004/a2a/browse/preview/` and features a mock LLM.
42
+ To use a real LLM, simply bind your app to an existing instance of SAP AI Core and start your server in `hybrid` profile:
43
+
44
+ ```bash
45
+ cds bind -2 <instance>
46
+ cds w --profile hybrid
47
+ ```
48
+
49
+ See [SAP AI Core → Create a Service Instance](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-service-instance) for how to create an instance.
50
+
51
+ ## Ways to Build Agents
52
+
53
+ Both approaches start from a CDS service annotated with `@agent` (as shown in [Requirements and Setup](#requirements-and-setup)). They differ only in how the agent's behaviour is defined.
54
+
55
+ ### Agentify Existing CAP Services
56
+
57
+ With `@agent` alone, the plugin auto-generates tools from the service's entities and actions, creates a ReAct agent loop, and serves it as a remote agent — no code required.
58
+
59
+ ```cds
60
+ @agent
61
+ service CatalogService {
62
+ entity Books as projection on my.Books;
63
+ action submitOrder(book: Books:ID, quantity: Integer) returns { stock: Integer };
64
+ }
65
+ ```
66
+
67
+ ### Markdown-Based Agents
68
+
69
+ To define an agent's identity, behaviour, and skills explicitly, add a sibling directory matching the slugified service name. When present, it replaces the default agentification: instead of the auto-generated ReAct agent, the plugin auto-builds the agent from the directory at startup — no JavaScript handler required.
70
+
71
+ ```
72
+ srv/
73
+ ├─ cat-service.cds
74
+ └─ catalog-agent/ ← matches the slugified service name
75
+ ├─ AGENTS.md ← agent identity + behaviour
76
+ └─ skills/
77
+ └─ book-purchase/
78
+ └─ SKILL.md ← workflow + examples
79
+ ```
80
+
81
+ `AGENTS.md` defines who the agent is. The frontmatter populates the agent card;
82
+ the body is the agent's system prompt:
83
+
84
+ ```md
85
+ ---
86
+ name: catalog-agent
87
+ version: "1.0.0"
88
+ description: >
89
+ Bookshop assistant for placing book orders on behalf of the user.
90
+ ---
91
+
92
+ # Catalog Agent
93
+
94
+ ## Identity
95
+
96
+ You are the **Catalog Agent**, a helpful assistant for the capire bookshop.
97
+ ...
98
+ ```
99
+
100
+ ## Human-in-the-Loop
101
+
102
+ Annotate a CDS action with `@agent.hitl` to require human approval before the agent may execute it. When the agent decides to call the action, the task pauses and transitions to the A2A [`input-required`](https://a2a-protocol.org/latest/specification/#413-taskstate) state instead of running the action immediately.
103
+
104
+ ```cds
105
+ // srv/cat-service.cds
106
+ ...
107
+ annotate CatalogService.submitOrder with @agent.hitl;
108
+ ```
109
+
110
+ ## Configuration
111
+
112
+ The LLM used by an agent is configured via `cds.requires.llm`. You can provide a `kind` as with [any required service](https://cap.cloud.sap/docs/node.js/core-services#required-services).
113
+
114
+ ```jsonc
115
+ "cds": {
116
+ "requires": {
117
+ "llm": {
118
+ "kind": "aicore",
119
+ "model": "anthropic--claude-4.6-sonnet"
120
+ }
121
+ }
122
+ }
123
+ ```
124
+
125
+ | Kind | Description |
126
+ | -------- | --------------------------------------------------------------------- |
127
+ | `aicore` | The default for `production` and `hybrid`, connects to SAP AI Core |
128
+ | `mock` | The default for `development`, provides a mocked response when called |
129
+
130
+ ## Advanced
131
+
132
+ The following capabilities are experimental and documented separately. Their public surface may change.
133
+
134
+ - [Connectivity](.docs/connectivity.md) — destination-based connectivity, `AICORE_SERVICE_KEY` / `ANTHROPIC_API_KEY`, and the `anthropic` kind
135
+ - [Configuration](.docs/configuration.md) — using multiple models, global and per-service settings, file I/O, and push notifications
136
+ - [Quota Enforcement](.docs/quota.md) — configurable rate limits and resource quotas
137
+ - [Audit Logging](.docs/audit-logging.md) — immutable audit trail of agent decisions and tool usage
138
+ - [Telemetry](.docs/telemetry.md) — OpenTelemetry metrics, tracing, and MLflow export
139
+ - [Content Filter](.docs/content-filter.md) — SAP AI Core content filtering and prompt injection shielding
140
+
141
+ ## Support, Feedback, Contributing
142
+
143
+ This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/agents/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
144
+
145
+ ## Security / Disclosure
146
+
147
+ If you find any bug that may be a security problem, please follow the instructions found [in our security policy](https://github.com/cap-js/agents/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
148
+
149
+ ## Code of Conduct
150
+
151
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
152
+
153
+ ## Licensing
154
+
155
+ Copyright 2026 SAP SE or an SAP affiliate company and cap-js/mcp contributors. Please see our [LICENSE](./LICENSES/Apache-2.0.txt) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/agents).
@@ -0,0 +1,31 @@
1
+ # Agent status messages (shown during task execution)
2
+ agent_status_calling_tools = Calling {0}
3
+ agent_status_querying = Querying {0}
4
+ agent_status_processing_response = Processing tool response
5
+ agent_status_processing_responses = Processing tool responses
6
+
7
+ # Authentication
8
+ UNAUTHORIZED = Unauthorized
9
+ FORBIDDEN = Forbidden
10
+
11
+ # Input validation
12
+ MESSAGE_TOO_LONG = The message must not exceed {0} characters.
13
+
14
+ # Quota enforcement
15
+ QUOTA_CONCURRENT_TASKS = The maximum of {0} concurrent tasks is reached. Please try again later.
16
+ QUOTA_CONCURRENT_TASKS_PER_USER = The maximum of {0} concurrent tasks per user is reached. Please try again later.
17
+ QUOTA_TASKS_PER_HOUR = The maximum of {0} tasks per hour for this tenant is reached. Please try again later.
18
+ QUOTA_TASKS_PER_HOUR_PER_USER = The maximum of {0} tasks per hour per user is reached. Please try again later.
19
+ QUOTA_TOOL_CALLS_PER_HOUR = The maximum amount of tool calls per hour was used ({0}). Please try again later.
20
+ QUOTA_LLM_TOKENS_PER_DAY = The maximum amount of LLM tokens for today was already used ({0}). Please try again tomorrow.
21
+
22
+ # Content filter
23
+ CONTENT_FILTER_BLOCKED = Your input was blocked by the content safety filter. Please rephrase.
24
+ CONTENT_FILTER_UNAVAILABLE = The content safety check is temporarily unavailable. Please try again.
25
+ CONTENT_FILTER_TOOL_BLOCKED = The last tool called yielded a malicious result. Please try a different direction to avoid the same malicious data.
26
+
27
+ # Push notifications
28
+ PUSH_URL_NOT_ALLOWED = Push notification callback URL ''{0}'' not in allowed domains: {1}
29
+
30
+ # HITL
31
+ RESUME_REQUIRES_TEXT = Resume message must contain text (e.g. ''approve'' or ''reject'') or a data part.
package/cds-plugin.js ADDED
@@ -0,0 +1,140 @@
1
+ import cds from "@sap/cds"
2
+
3
+ const LOG = cds.log("agents")
4
+ import { patchLangChain } from "./lib/telemetry/tracing.js"
5
+ import cds_compile_to_a2a from "./lib/compile.js"
6
+ import registerDefaultAgentHandlers from "./srv/handlers/index.js"
7
+ import { slugified } from "./lib/utils/markdown.js"
8
+
9
+ cds.compile.to.a2a = cds_compile_to_a2a
10
+
11
+ // Detect optional peer plugins (@cap-js/telemetry, @cap-js/audit-logging)
12
+ const hasTelemetry = !!cds.env.requires?.telemetry
13
+ const hasAuditLog = !!cds.env.requires?.["audit-log"]
14
+ const hasMetrics = !!cds.env.requires?.telemetry?.["metrics"]
15
+ const hasTracing = !!cds.env.requires?.telemetry?.["tracing"]
16
+ if (!hasTelemetry && cds.env.profiles?.includes("production"))
17
+ LOG.warn("@cap-js/telemetry not configured - metrics and tracing disabled")
18
+ if (!hasAuditLog && cds.env.profiles?.includes("production"))
19
+ LOG.warn("@cap-js/audit-logging not configured - audit events disabled")
20
+ if (hasTelemetry && !hasMetrics && cds.env.profiles?.includes("production"))
21
+ LOG.warn("@cap-js/telemetry has no metrics configured - metrics disabled")
22
+ if (hasTelemetry && !hasTracing && cds.env.profiles?.includes("production"))
23
+ LOG.warn("@cap-js/telemetry has no tracing configured - tracing disabled")
24
+
25
+ // Enable doc comments in CSN for agent card generation
26
+ cds.env.cdsc = { ...cds.env.cdsc, docComment: true }
27
+
28
+ // Ensure A2A correlation fields are indexed by SAP Cloud Logging
29
+ cds.env.log ??= {}
30
+ const cls_fields = (cds.env.log.cls_custom_fields ??= [])
31
+ if (!cls_fields.includes("agent.task.id")) cls_fields.push("agent.task.id")
32
+ if (!cls_fields.includes("agent.context.id")) cls_fields.push("agent.context.id")
33
+
34
+ cds.on("bootstrap", (app) => {
35
+ const providers = {
36
+ ["llm-mock"]: {},
37
+ anthropic: {
38
+ opus: "claude-opus-latest",
39
+ sonnet: "claude-sonnet-latest",
40
+ haiku: "claude-haiku-latest",
41
+ },
42
+ aicore: {
43
+ opus: "anthropic--claude-4.8-opus",
44
+ sonnet: "anthropic--claude-4.6-sonnet",
45
+ haiku: "anthropic--claude-4.5-haiku",
46
+ },
47
+ }
48
+
49
+ for (const [name, s] of Object.entries(cds.env.requires)) {
50
+ const kind = s?.kind ?? s
51
+ if (typeof kind !== "string") continue
52
+ let [provider, model] = kind.split("/")
53
+ if (name.startsWith("llm") && !providers[provider] && providers["llm-" + provider])
54
+ provider = "llm-" + provider
55
+ if (providers[provider] && model) {
56
+ s.kind = provider
57
+ s.model = providers[provider][model] ?? model
58
+ }
59
+ }
60
+
61
+ const profiles = cds.env.profiles || []
62
+ const isDev = profiles.includes("development") && !profiles.includes("production")
63
+ if (!isDev) return
64
+ if (cds.env.server?.index === false) return
65
+
66
+ const AGENT_BLOCK = /(<div id="[^"]+-agent">[\s\S]*?<\/h3>)[\s\S]*?<\/ul>\s*<\/div>/g
67
+
68
+ app.get("/", (_req, res, next) => {
69
+ const origSend = res.send.bind(res)
70
+ res.send = (body) => {
71
+ if (typeof body === "string") {
72
+ body = body.replace(AGENT_BLOCK, (_m, head) => `${head}\n </div>`)
73
+ }
74
+ return origSend(body)
75
+ }
76
+ next()
77
+ })
78
+ })
79
+
80
+ cds.on("serving", (srv) => {
81
+ if (!(srv instanceof cds.ApplicationService)) return
82
+ if (!srv.definition?.["@agent"]) return
83
+ registerDefaultAgentHandlers(srv)
84
+ })
85
+
86
+ // Schedule active_users metric computation + MLflow exporter
87
+ cds.on("served", async () => {
88
+ if (hasTelemetry) {
89
+ const { setupActiveUsersMetric } = await import("./lib/telemetry/active-users.js")
90
+ setupActiveUsersMetric()
91
+ // Defer LangChain patching so the CDS model is fully loaded before patches land.
92
+ // opt-out via cds.env.agents.trace_langchain = false
93
+ if (cds.env.agents?.trace_langchain !== false) {
94
+ await patchLangChain()
95
+ }
96
+ }
97
+
98
+ if (cds.env.agents?.mlflow) {
99
+ const { setupMlflowExporter } = await import("./lib/telemetry/mlflow.js")
100
+ setupMlflowExporter()
101
+ }
102
+ })
103
+
104
+ // Bootstrap sidecar mode when the agent-sidecar profile is active
105
+ if (cds.env.profiles?.includes("agent-sidecar")) {
106
+ // Auto-mark @agent services as external so CDS does not serve them locally.
107
+ // Auto-mark them as hcql services served externally, they are served from the main app.
108
+ // This runs after model load but before cds.serve() filters definitions,
109
+ // so users don't need to add these things manually.
110
+ cds.on("loaded", (csn) => {
111
+ const hcql = cds.requires.kinds["hcql"]
112
+ const agentSidecar = cds.requires.agent || {}
113
+ const hcqlBase = agentSidecar.url // For local development the base URL is given in the package.json
114
+ const agentCredentials = agentSidecar.credentials || {}
115
+ for (const [name, def] of Object.entries(csn.definitions || {})) {
116
+ if (def.kind !== "service") continue
117
+ if (!def["@agent"]) continue
118
+ // Mark as external so CDS does not serve it locally — it will be served via HCQL from the main app.
119
+ def["@cds.external"] = true
120
+ // Java main apps use the CDS service name in the HCQL path (/hcql/CatalogService),
121
+ // Node.js main apps use the slugified path (/hcql/catalog).
122
+ const isJava = !cds.env.profiles?.includes("node")
123
+ let n = isJava ? name : slugified(name)
124
+ if (cds.requires[name]) continue // skip if user provided service-specific config for this service
125
+ if (cds.requires[n]) continue // skip if user provided service-specific config for possibly the slugified version
126
+ const newRequiresEntry = { ...hcql, kind: "hcql" }
127
+ newRequiresEntry.credentials = {
128
+ ...agentCredentials,
129
+ ...(hcqlBase && { url: `${hcqlBase}/${n.split(".").pop()}` }),
130
+ ...(agentCredentials.destination && { path: `/${n.split(".").pop()}` }),
131
+ }
132
+ cds.requires[n] = newRequiresEntry
133
+ }
134
+ })
135
+
136
+ cds.on("served", async () => {
137
+ const { bootstrapSidecar } = await import("./lib/sidecar.js")
138
+ await bootstrapSidecar()
139
+ })
140
+ }
package/index.cds ADDED
@@ -0,0 +1,105 @@
1
+ using {managed} from '@sap/cds/common';
2
+ using {Attachments} from '@cap-js/attachments';
3
+
4
+ namespace cap.agent;
5
+
6
+ /**
7
+ * Stores A2A task objects for retrieval via tasks/get.
8
+ */
9
+ entity Tasks : managed {
10
+ /**
11
+ * A2A task ID (server-generated UUID)
12
+ */
13
+ key taskId : String;
14
+ /**
15
+ * Groups related tasks into conversations
16
+ */
17
+ contextId : String;
18
+ /**
19
+ * Current task state (submitted, working, completed, failed, etc.)
20
+ */
21
+ state : String;
22
+ /**
23
+ * Full serialized A2A Task JSON
24
+ */
25
+ data : LargeString;
26
+ /**
27
+ * Fully qualified CDS service name
28
+ */
29
+ agentService : String;
30
+ /**
31
+ * Combined LLM Input and Output tokens used for this task
32
+ */
33
+ usageLlmTokens : Integer64 default 0;
34
+ /**
35
+ * Amount of tool calls made by this task
36
+ */
37
+ usageToolCalls : Integer default 0;
38
+
39
+ /** Push notification (webhook) configs for this task. Cascade-deleted. */
40
+ pushConfigs : Composition of many PushNotificationConfigs
41
+ on pushConfigs.taskId = taskId;
42
+
43
+ /**
44
+ * Files received from user or downstream agents for this task.
45
+ * Conversation-scoped reads use up_.contextId path expression.
46
+ */
47
+ inputFiles : Composition of many Attachments;
48
+
49
+ /**
50
+ * Files written by agent via /outputs/ path for this task.
51
+ */
52
+ outputFiles : Composition of many Attachments;
53
+ }
54
+
55
+ entity Checkpoints : managed {
56
+ key thread_id : String;
57
+ key checkpoint_ns : String default '';
58
+ key checkpoint_id : String;
59
+ parent_checkpoint_id : String;
60
+ parent : Association to one Checkpoints
61
+ on parent.checkpoint_id = parent_checkpoint_id;
62
+ checkpoint : LargeString;
63
+ metadata : LargeString;
64
+ writes : Composition of many CheckpointWrites
65
+ on writes.thread_id = thread_id
66
+ and writes.checkpoint_ns = checkpoint_ns
67
+ and writes.checkpoint_id = checkpoint_id;
68
+ }
69
+
70
+ entity CheckpointWrites {
71
+ key thread_id : String;
72
+ key checkpoint_ns : String default '';
73
+ key checkpoint_id : String;
74
+ checkpoint : Association to one Checkpoints
75
+ on checkpoint.checkpoint_id = checkpoint_id
76
+ and checkpoint.checkpoint_ns = checkpoint_ns
77
+ and checkpoint.thread_id = thread_id;
78
+ key task_id : String;
79
+ task : Association to one Tasks
80
+ on task.taskId = task_id;
81
+ key idx : Integer;
82
+ channel : String;
83
+ value : LargeString;
84
+ }
85
+
86
+ /**
87
+ * Stores push notification (webhook) configs registered by clients for task updates.
88
+ *
89
+ * REVISIT: A2A spec supports `authentication: { schemes: ["Bearer"], credentials: "..." }`
90
+ * and `token` fields on PushNotificationConfig for authenticated callbacks. When needed:
91
+ * 1. Add `schemes: String(512)` column (non-secret metadata, JSON array e.g. '["Bearer"]')
92
+ * 2. Store token/credentials in SAP Credential Store — NOT in DB
93
+ * - Use @sap-cloud-sdk/connectivity getServiceBinding("credstore") for binding
94
+ * - Use @sap-cloud-sdk/http-client executeHttpRequest with mTLS destination
95
+ * - Throw at save-time if credstore not bound but secret provided (not at startup)
96
+ * 3. Implement custom PushNotificationSender (6th arg to DefaultRequestHandler) that
97
+ * sends `Authorization: <scheme> <credentials>` header from authentication field
98
+ * and `X-A2A-Notification-Token` header from token field
99
+ */
100
+ entity PushNotificationConfigs : managed {
101
+ key taskId : String;
102
+ key configId : String;
103
+ task : Association to one Tasks on task.taskId = taskId;
104
+ url : String(2048);
105
+ }
package/index.js ADDED
File without changes
@@ -0,0 +1,37 @@
1
+ export function isTextMime(mimeType) {
2
+ if (!mimeType) return false
3
+ if (mimeType.startsWith("text/")) return true
4
+ return [
5
+ "application/json",
6
+ "application/xml",
7
+ "application/csv",
8
+ "application/x-ndjson",
9
+ "application/ld+json",
10
+ "application/graphql",
11
+ "application/yaml",
12
+ "application/x-yaml",
13
+ "application/toml",
14
+ "application/javascript",
15
+ "application/ecmascript",
16
+ "application/sql",
17
+ ].includes(mimeType)
18
+ }
19
+
20
+ export function globToRegex(pattern) {
21
+ let re = "^"
22
+ for (let i = 0; i < pattern.length; i++) {
23
+ const c = pattern[i]
24
+ if (c === "*") re += ".*"
25
+ else if (c === "?") re += "."
26
+ else if (c === "[") {
27
+ const close = pattern.indexOf("]", i)
28
+ if (close === -1) re += "\\["
29
+ else {
30
+ re += pattern.slice(i, close + 1)
31
+ i = close
32
+ }
33
+ } else if (".+^${}()|\\".includes(c)) re += "\\" + c
34
+ else re += c
35
+ }
36
+ return new RegExp(re + "$")
37
+ }