@signalwire/sdk 2.0.0 → 2.0.2

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 (612) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/dist/index.d.ts +146 -0
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1019 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
  149. package/dist/rest/index.js +195 -0
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/dist/rest/pagination.d.ts +39 -0
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2489
  416. package/src/AgentServer.ts +0 -415
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1150
  420. package/src/DataMap.ts +0 -449
  421. package/src/FunctionResult.ts +0 -866
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -439
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -717
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -221
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -258
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -181
  435. package/src/WebService.ts +0 -619
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/index.ts +0 -167
  441. package/src/livewire/index.ts +0 -950
  442. package/src/prefabs/ConciergeAgent.ts +0 -287
  443. package/src/prefabs/FAQBotAgent.ts +0 -384
  444. package/src/prefabs/InfoGathererAgent.ts +0 -339
  445. package/src/prefabs/ReceptionistAgent.ts +0 -366
  446. package/src/prefabs/SurveyAgent.ts +0 -646
  447. package/src/relay/Action.ts +0 -314
  448. package/src/relay/Call.ts +0 -854
  449. package/src/relay/Deferred.ts +0 -71
  450. package/src/relay/Message.ts +0 -148
  451. package/src/relay/RelayClient.ts +0 -1036
  452. package/src/relay/RelayError.ts +0 -14
  453. package/src/relay/RelayEvent.ts +0 -892
  454. package/src/relay/index.ts +0 -123
  455. package/src/relay/types.ts +0 -149
  456. package/src/rest/HttpClient.ts +0 -103
  457. package/src/rest/RestError.ts +0 -31
  458. package/src/rest/base/BaseResource.ts +0 -19
  459. package/src/rest/base/CrudResource.ts +0 -51
  460. package/src/rest/base/CrudWithAddresses.ts +0 -26
  461. package/src/rest/namespaces/addresses.ts +0 -32
  462. package/src/rest/namespaces/calling.ts +0 -187
  463. package/src/rest/namespaces/chat.ts +0 -20
  464. package/src/rest/namespaces/compat.ts +0 -352
  465. package/src/rest/namespaces/datasphere.ts +0 -45
  466. package/src/rest/namespaces/fabric.ts +0 -222
  467. package/src/rest/namespaces/imported-numbers.ts +0 -20
  468. package/src/rest/namespaces/logs.ts +0 -84
  469. package/src/rest/namespaces/lookup.ts +0 -21
  470. package/src/rest/namespaces/mfa.ts +0 -30
  471. package/src/rest/namespaces/number-groups.ts +0 -38
  472. package/src/rest/namespaces/phone-numbers.ts +0 -44
  473. package/src/rest/namespaces/project.ts +0 -36
  474. package/src/rest/namespaces/pubsub.ts +0 -20
  475. package/src/rest/namespaces/queues.ts +0 -33
  476. package/src/rest/namespaces/recordings.ts +0 -28
  477. package/src/rest/namespaces/registry.ts +0 -101
  478. package/src/rest/namespaces/short-codes.ts +0 -28
  479. package/src/rest/namespaces/sip-profile.ts +0 -25
  480. package/src/rest/namespaces/verified-callers.ts +0 -27
  481. package/src/rest/namespaces/video.ts +0 -165
  482. package/src/rest/pagination.ts +0 -84
  483. package/src/rest/types.ts +0 -61
  484. package/src/skills/SkillBase.ts +0 -547
  485. package/src/skills/SkillManager.ts +0 -415
  486. package/src/skills/SkillRegistry.ts +0 -367
  487. package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
  488. package/src/skills/builtin/ask_claude.ts +0 -241
  489. package/src/skills/builtin/claude_skills.ts +0 -978
  490. package/src/skills/builtin/custom_skills.ts +0 -312
  491. package/src/skills/builtin/datasphere.ts +0 -438
  492. package/src/skills/builtin/datasphere_serverless.ts +0 -339
  493. package/src/skills/builtin/datetime.ts +0 -130
  494. package/src/skills/builtin/google_maps.ts +0 -651
  495. package/src/skills/builtin/info_gatherer.ts +0 -405
  496. package/src/skills/builtin/joke.ts +0 -191
  497. package/src/skills/builtin/math.ts +0 -142
  498. package/src/skills/builtin/mcp_gateway.ts +0 -677
  499. package/src/skills/builtin/native_vector_search.ts +0 -901
  500. package/src/skills/builtin/play_background_file.ts +0 -358
  501. package/src/skills/builtin/spider.ts +0 -869
  502. package/src/skills/builtin/swml_transfer.ts +0 -635
  503. package/src/skills/builtin/weather_api.ts +0 -248
  504. package/src/skills/builtin/web_search.ts +0 -1074
  505. package/src/skills/builtin/wikipedia_search.ts +0 -299
  506. package/src/types.ts +0 -132
  507. package/tests/AgentBase.test.ts +0 -1093
  508. package/tests/AgentServer.test.ts +0 -126
  509. package/tests/AuthHandler.test.ts +0 -133
  510. package/tests/ConfigLoader.test.ts +0 -151
  511. package/tests/ContextBuilder.test.ts +0 -108
  512. package/tests/DataMap.test.ts +0 -367
  513. package/tests/EphemeralSkillCopy.test.ts +0 -107
  514. package/tests/FunctionResult.test.ts +0 -298
  515. package/tests/GracefulShutdown.test.ts +0 -46
  516. package/tests/Logger.test.ts +0 -420
  517. package/tests/PomBuilder.test.ts +0 -228
  518. package/tests/ProxyDetection.test.ts +0 -228
  519. package/tests/SWMLService.test.ts +0 -320
  520. package/tests/SWMLVerbHandler.test.ts +0 -523
  521. package/tests/SchemaUtils.test.ts +0 -106
  522. package/tests/SchemaUtils.verb.test.ts +0 -206
  523. package/tests/SecurityUtils.test.ts +0 -192
  524. package/tests/ServerlessAdapter.test.ts +0 -222
  525. package/tests/SessionManager.test.ts +0 -257
  526. package/tests/SkillBaseFeatures.test.ts +0 -130
  527. package/tests/SkillMultiInstance.test.ts +0 -102
  528. package/tests/SkillParameterSchemas.test.ts +0 -134
  529. package/tests/SkillRegistrySchema.test.ts +0 -84
  530. package/tests/SslConfig.test.ts +0 -97
  531. package/tests/SwmlBuilder.test.ts +0 -400
  532. package/tests/TypeInference.test.ts +0 -165
  533. package/tests/VerbHandlerRegistry.test.ts +0 -128
  534. package/tests/cli/mock-data.test.ts +0 -113
  535. package/tests/cli/swaig-test.test.ts +0 -108
  536. package/tests/examples.test.ts +0 -194
  537. package/tests/fixtures/scrape-parity/README.md +0 -53
  538. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  548. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  549. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  550. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  551. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  552. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  553. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  554. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  555. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  556. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  557. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  558. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  559. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  560. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  561. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  562. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  563. package/tests/livewire/livewire.test.ts +0 -780
  564. package/tests/mcp.test.ts +0 -221
  565. package/tests/prefabs/prefabs.test.ts +0 -1093
  566. package/tests/relay/Action.test.ts +0 -392
  567. package/tests/relay/Call.test.ts +0 -535
  568. package/tests/relay/Deferred.test.ts +0 -71
  569. package/tests/relay/Message.test.ts +0 -164
  570. package/tests/relay/RelayClient.test.ts +0 -779
  571. package/tests/relay/RelayEvent.test.ts +0 -463
  572. package/tests/relay/helpers.ts +0 -79
  573. package/tests/rest/HttpClient.test.ts +0 -274
  574. package/tests/rest/RestError.test.ts +0 -53
  575. package/tests/rest/calling.test.ts +0 -156
  576. package/tests/rest/client.test.ts +0 -197
  577. package/tests/rest/compat.test.ts +0 -335
  578. package/tests/rest/datasphere.test.ts +0 -71
  579. package/tests/rest/fabric.test.ts +0 -186
  580. package/tests/rest/helpers.ts +0 -95
  581. package/tests/rest/logs.test.ts +0 -68
  582. package/tests/rest/pagination.test.ts +0 -133
  583. package/tests/rest/registry.test.ts +0 -94
  584. package/tests/rest/relay-rest.test.ts +0 -290
  585. package/tests/rest/video.test.ts +0 -173
  586. package/tests/setup.ts +0 -6
  587. package/tests/skills/SkillBase.test.ts +0 -108
  588. package/tests/skills/SkillManager.test.ts +0 -268
  589. package/tests/skills/SkillRegistry.test.ts +0 -176
  590. package/tests/skills/builtin.test.ts +0 -1472
  591. package/tests/skills/claude-skills.test.ts +0 -54
  592. package/tests/skills/custom-skills.test.ts +0 -53
  593. package/tests/skills/datasphere-serverless.test.ts +0 -70
  594. package/tests/skills/datasphere.test.ts +0 -107
  595. package/tests/skills/datetime.test.ts +0 -101
  596. package/tests/skills/google-maps.test.ts +0 -78
  597. package/tests/skills/info-gatherer.test.ts +0 -411
  598. package/tests/skills/joke.test.ts +0 -81
  599. package/tests/skills/math.test.ts +0 -68
  600. package/tests/skills/mcp-gateway.test.ts +0 -101
  601. package/tests/skills/play-background.test.ts +0 -54
  602. package/tests/skills/spider.test.ts +0 -108
  603. package/tests/skills/swml-transfer.test.ts +0 -178
  604. package/tests/skills/trivia.test.ts +0 -54
  605. package/tests/skills/vector-search.test.ts +0 -135
  606. package/tests/skills/weather-api.test.ts +0 -77
  607. package/tests/skills/web-search-parity.test.ts +0 -59
  608. package/tests/skills/web-search.test.ts +0 -103
  609. package/tests/skills/wikipedia.test.ts +0 -63
  610. package/tsconfig.json +0 -18
  611. package/vitest.config.ts +0 -9
  612. /package/{src → dist}/schema.json +0 -0
@@ -1,677 +0,0 @@
1
- /**
2
- * MCP Gateway Skill - Bridge MCP servers with SWAIG functions.
3
- *
4
- * Port of the Python `MCPGatewaySkill`. Connects SignalWire agents to a
5
- * Model Context Protocol gateway HTTP service and dynamically registers
6
- * SWAIG tools for every MCP tool exposed by the configured services.
7
- *
8
- * Authentication: Bearer token (via `auth_token`) or HTTP Basic auth
9
- * (via `auth_user` + `auth_password`). Supports configurable timeouts,
10
- * retry attempts, and SSL verification.
11
- */
12
-
13
- import { SkillBase } from '../SkillBase.js';
14
- import type {
15
- SkillToolDefinition,
16
- SkillPromptSection,
17
- SkillConfig,
18
- ParameterSchemaEntry,
19
- } from '../SkillBase.js';
20
- import { FunctionResult } from '../../FunctionResult.js';
21
- import { getLogger } from '../../Logger.js';
22
- import { validateUrl } from '../../SecurityUtils.js';
23
- import { Agent as UndiciAgent } from 'undici';
24
-
25
- const log = getLogger('McpGatewaySkill');
26
-
27
- /** Configuration entry for a single MCP service to expose. */
28
- interface McpServiceConfig {
29
- /** Service name as registered on the gateway. */
30
- name: string;
31
- /** Tools to expose: '*' for all, array of names to filter, or undefined. */
32
- tools?: string | string[];
33
- }
34
-
35
- /** MCP tool definition returned by the gateway's /services/<name>/tools endpoint. */
36
- interface McpToolDefinition {
37
- name: string;
38
- description?: string;
39
- inputSchema?: {
40
- properties?: Record<string, { type?: string; description?: string; enum?: unknown[]; default?: unknown }>;
41
- required?: string[];
42
- };
43
- }
44
-
45
- /**
46
- * Bridge MCP (Model Context Protocol) servers with SWAIG functions.
47
- *
48
- * When configured, calls a gateway's `/services` endpoint to discover MCP
49
- * services, enumerates each service's tools, and registers them as SWAIG
50
- * tools prefixed with `tool_prefix` (default `mcp_`). A hidden hangup hook
51
- * tool cleans up MCP sessions when the call ends.
52
- */
53
- export class McpGatewaySkill extends SkillBase {
54
- // Python ground truth: skills/mcp_gateway/skill.py:~70-76
55
- // REQUIRED_PACKAGES = ["requests"] in Python; TS uses undici for SSL dispatch.
56
- // Python does not set SUPPORTS_MULTIPLE_INSTANCES so it inherits the default (False).
57
- static override SKILL_NAME = 'mcp_gateway';
58
- static override SKILL_DESCRIPTION = 'Bridge MCP servers with SWAIG functions';
59
- static override SKILL_VERSION = '1.0.0';
60
- static override REQUIRED_PACKAGES: readonly string[] = ['undici'];
61
- static override REQUIRED_ENV_VARS: readonly string[] = [];
62
-
63
- static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
64
- return {
65
- ...super.getParameterSchema(),
66
- gateway_url: {
67
- type: 'string',
68
- description: 'URL of the MCP Gateway service',
69
- required: true,
70
- },
71
- auth_token: {
72
- type: 'string',
73
- description:
74
- 'Bearer token for authentication (alternative to basic auth)',
75
- required: false,
76
- hidden: true,
77
- env_var: 'MCP_GATEWAY_AUTH_TOKEN',
78
- },
79
- auth_user: {
80
- type: 'string',
81
- description:
82
- 'Username for basic authentication (required if auth_token not provided)',
83
- required: false,
84
- env_var: 'MCP_GATEWAY_AUTH_USER',
85
- },
86
- auth_password: {
87
- type: 'string',
88
- description:
89
- 'Password for basic authentication (required if auth_token not provided)',
90
- required: false,
91
- hidden: true,
92
- env_var: 'MCP_GATEWAY_AUTH_PASSWORD',
93
- },
94
- services: {
95
- type: 'array',
96
- description:
97
- 'List of MCP services to connect to (empty for all available)',
98
- default: [],
99
- required: false,
100
- items: {
101
- type: 'object',
102
- properties: {
103
- name: { type: 'string', description: 'Service name' },
104
- tools: {
105
- type: ['string', 'array'],
106
- description:
107
- "Tools to expose ('*' for all, or list of tool names)",
108
- },
109
- },
110
- },
111
- },
112
- session_timeout: {
113
- type: 'integer',
114
- description: 'Session timeout in seconds',
115
- default: 300,
116
- required: false,
117
- },
118
- tool_prefix: {
119
- type: 'string',
120
- description: 'Prefix for registered SWAIG function names',
121
- default: 'mcp_',
122
- required: false,
123
- },
124
- retry_attempts: {
125
- type: 'integer',
126
- description: 'Number of retry attempts for failed requests',
127
- default: 3,
128
- required: false,
129
- },
130
- request_timeout: {
131
- type: 'integer',
132
- description: 'Request timeout in seconds',
133
- default: 30,
134
- required: false,
135
- },
136
- verify_ssl: {
137
- type: 'boolean',
138
- description: 'Verify SSL certificates',
139
- default: true,
140
- required: false,
141
- },
142
- };
143
- }
144
-
145
- // Runtime state populated in setup()
146
- private gatewayUrl = '';
147
- private authToken: string | undefined;
148
- private authUser: string | undefined;
149
- private authPassword: string | undefined;
150
- private services: McpServiceConfig[] = [];
151
- private sessionTimeout = 300;
152
- private toolPrefix = 'mcp_';
153
- private retryAttempts = 3;
154
- private requestTimeout = 30;
155
- private verifySsl = true;
156
- private _discoveredTools: SkillToolDefinition[] = [];
157
- private _ready = false;
158
- /**
159
- * Cached undici Agent used when `verify_ssl=false`. Created once in
160
- * `setup()` and reused across every `_makeRequest` call to avoid
161
- * connection-pool churn (Python reuses `requests.Session` implicitly).
162
- */
163
- private _undiciAgent: UndiciAgent | undefined;
164
-
165
- override async setup(): Promise<boolean> {
166
- this.authToken =
167
- this.getConfig<string | undefined>('auth_token', undefined) ??
168
- process.env['MCP_GATEWAY_AUTH_TOKEN'];
169
-
170
- const gatewayUrl = this.getConfig<string | undefined>('gateway_url', undefined);
171
- if (!gatewayUrl) {
172
- log.error('mcp_gateway: missing required parameter: gateway_url');
173
- return false;
174
- }
175
-
176
- if (!this.authToken) {
177
- this.authUser =
178
- this.getConfig<string | undefined>('auth_user', undefined) ??
179
- process.env['MCP_GATEWAY_AUTH_USER'];
180
- this.authPassword =
181
- this.getConfig<string | undefined>('auth_password', undefined) ??
182
- process.env['MCP_GATEWAY_AUTH_PASSWORD'];
183
- if (!this.authUser || !this.authPassword) {
184
- log.error(
185
- 'mcp_gateway: missing required parameters: auth_token or (auth_user + auth_password)',
186
- );
187
- return false;
188
- }
189
- }
190
-
191
- this.gatewayUrl = gatewayUrl.replace(/\/+$/, '');
192
-
193
- // SSRF protection — match Python skills/mcp_gateway/skill.py:147-148 which
194
- // calls validate_url(self.gateway_url) before the health check. Reject
195
- // private/loopback/metadata-endpoint URLs in multi-tenant deployments.
196
- if (!(await validateUrl(this.gatewayUrl))) {
197
- log.error('mcp_gateway: gateway_url rejected by SSRF protection', {
198
- url: this.gatewayUrl,
199
- });
200
- return false;
201
- }
202
-
203
- this.services =
204
- this.getConfig<McpServiceConfig[]>('services', []) ?? [];
205
- this.sessionTimeout = this.getConfig<number>('session_timeout', 300);
206
- this.toolPrefix = this.getConfig<string>('tool_prefix', 'mcp_');
207
- this.retryAttempts = this.getConfig<number>('retry_attempts', 3);
208
- this.requestTimeout = this.getConfig<number>('request_timeout', 30);
209
- this.verifySsl = this.getConfig<boolean>('verify_ssl', true);
210
-
211
- // Cache a single undici Agent for SSL-bypass mode so each request reuses
212
- // the same connection pool (parity with Python requests.Session behavior).
213
- if (!this.verifySsl) {
214
- this._undiciAgent = new UndiciAgent({
215
- connect: { rejectUnauthorized: false },
216
- });
217
- }
218
-
219
- // Validate gateway connectivity
220
- try {
221
- const health = await this._makeRequest('GET', `${this.gatewayUrl}/health`);
222
- if (!health.ok) {
223
- log.error('mcp_gateway: gateway health check failed', {
224
- status: health.status,
225
- });
226
- return false;
227
- }
228
- log.info('mcp_gateway: connected', { url: this.gatewayUrl });
229
- } catch (err) {
230
- log.error('mcp_gateway: failed to connect to gateway', {
231
- error: err instanceof Error ? err.message : String(err),
232
- });
233
- return false;
234
- }
235
-
236
- // Discover tools (equivalent of Python register_tools())
237
- try {
238
- await this._discoverTools();
239
- this._ready = true;
240
- return true;
241
- } catch (err) {
242
- log.error('mcp_gateway: tool discovery failed', {
243
- error: err instanceof Error ? err.message : String(err),
244
- });
245
- return false;
246
- }
247
- }
248
-
249
- override getHints(): string[] {
250
- const hints = ['MCP', 'gateway'];
251
- const services =
252
- this.services.length > 0
253
- ? this.services
254
- : (this.getConfig<McpServiceConfig[]>('services', []) ?? []);
255
- for (const service of services) {
256
- if (service && typeof service === 'object' && service.name) {
257
- hints.push(service.name);
258
- }
259
- }
260
- return hints;
261
- }
262
-
263
- override getGlobalData(): Record<string, unknown> {
264
- if (!this._ready) return {};
265
- // Python skill.py emits mcp_session_id = self.session_id, which Python
266
- // initializes to None in setup() and never updates. Per-call session IDs
267
- // live in local scope inside _call_mcp_tool — never mutate shared state.
268
- return {
269
- mcp_gateway_url: this.gatewayUrl,
270
- mcp_session_id: null,
271
- mcp_services: this.services.map((s) =>
272
- typeof s === 'object' && s !== null ? s.name : String(s),
273
- ),
274
- };
275
- }
276
-
277
- /**
278
- * @returns Dynamically discovered MCP tools plus an internal hangup-cleanup
279
- * tool. If discovery has not completed, returns a single fallback
280
- * `mcp_invoke` tool that explains configuration is missing.
281
- */
282
- getTools(): SkillToolDefinition[] {
283
- if (!this._ready || this._discoveredTools.length === 0) {
284
- return [
285
- {
286
- name: 'mcp_invoke',
287
- description:
288
- 'MCP gateway is not configured. Provide gateway_url and credentials to enable this skill.',
289
- parameters: {
290
- server: {
291
- type: 'string',
292
- description: 'The MCP server/service name.',
293
- },
294
- method: {
295
- type: 'string',
296
- description: 'The method/tool name to invoke.',
297
- },
298
- params: {
299
- type: 'object',
300
- description: 'Parameters to pass to the MCP method.',
301
- },
302
- },
303
- required: ['server', 'method'],
304
- handler: () =>
305
- new FunctionResult(
306
- 'MCP gateway is not configured. Set gateway_url and an auth method (auth_token or auth_user/auth_password) on the skill config.',
307
- ),
308
- },
309
- ];
310
- }
311
-
312
- // Append hangup hook tool — isHangupHook causes the platform to auto-fire
313
- // this on call hangup (Python: is_hangup_hook=True in define_tool).
314
- const tools = [...this._discoveredTools];
315
- tools.push({
316
- name: '_mcp_gateway_hangup',
317
- description: 'Internal cleanup function for MCP sessions',
318
- parameters: {},
319
- handler: (args: Record<string, unknown>, rawData: Record<string, unknown>) =>
320
- this._hangupHandler(args, rawData),
321
- isHangupHook: true,
322
- });
323
- return tools;
324
- }
325
-
326
- /** @returns Prompt section listing configured MCP services. */
327
- protected override _getPromptSections(): SkillPromptSection[] {
328
- // Prefer runtime-resolved services (after setup); fall back to config.
329
- const services =
330
- this.services.length > 0
331
- ? this.services
332
- : (this.getConfig<McpServiceConfig[]>('services', []) ?? []);
333
- const gatewayUrl = this.gatewayUrl || this.getConfig<string>('gateway_url', '');
334
- const toolPrefix = this.toolPrefix || this.getConfig<string>('tool_prefix', 'mcp_');
335
- const serviceDescriptions: string[] = [];
336
- for (const service of services) {
337
- if (typeof service !== 'object' || service === null) continue;
338
- const name = service.name ?? 'Unknown';
339
- const tools = service.tools ?? '*';
340
- if (tools === '*') {
341
- serviceDescriptions.push(`${name} (all tools)`);
342
- } else if (Array.isArray(tools)) {
343
- serviceDescriptions.push(`${name} (${tools.length} tools)`);
344
- } else {
345
- serviceDescriptions.push(String(name));
346
- }
347
- }
348
-
349
- if (serviceDescriptions.length === 0) {
350
- return [];
351
- }
352
-
353
- return [
354
- {
355
- title: 'MCP Gateway Integration',
356
- body: 'You have access to external MCP (Model Context Protocol) services through a gateway.',
357
- bullets: [
358
- `Connected to gateway at ${gatewayUrl}`,
359
- `Available services: ${serviceDescriptions.join(', ')}`,
360
- `Functions are prefixed with '${toolPrefix}' followed by service name`,
361
- 'Each service maintains its own session state throughout the call',
362
- ],
363
- },
364
- ];
365
- }
366
-
367
- // ---------------------------------------------------------------------------
368
- // Internal helpers
369
- // ---------------------------------------------------------------------------
370
-
371
- /** Build auth + timeout-bearing fetch request to the gateway. */
372
- private async _makeRequest(
373
- method: string,
374
- url: string,
375
- options: { body?: unknown; headers?: Record<string, string> } = {},
376
- ): Promise<Response> {
377
- const headers: Record<string, string> = {
378
- Accept: 'application/json',
379
- ...(options.headers ?? {}),
380
- };
381
-
382
- if (this.authToken) {
383
- headers['Authorization'] = `Bearer ${this.authToken}`;
384
- } else if (this.authUser && this.authPassword) {
385
- const creds = Buffer.from(`${this.authUser}:${this.authPassword}`).toString(
386
- 'base64',
387
- );
388
- headers['Authorization'] = `Basic ${creds}`;
389
- }
390
-
391
- const init: RequestInit & { dispatcher?: unknown } = { method, headers };
392
- if (options.body !== undefined) {
393
- headers['Content-Type'] = 'application/json';
394
- init.body = JSON.stringify(options.body);
395
- }
396
-
397
- const controller = new AbortController();
398
- const timer = setTimeout(
399
- () => controller.abort(),
400
- this.requestTimeout * 1000,
401
- );
402
- init.signal = controller.signal;
403
-
404
- // Mirror Python `requests.request(..., verify=self.verify_ssl)`. Node's
405
- // built-in fetch has no SSL toggle, so reuse the undici Agent cached in
406
- // setup() rather than spinning up a fresh one on every call.
407
- if (this._undiciAgent) {
408
- init.dispatcher = this._undiciAgent;
409
- }
410
-
411
- try {
412
- return await fetch(url, init as RequestInit);
413
- } finally {
414
- clearTimeout(timer);
415
- }
416
- }
417
-
418
- /** Discover available services and register each MCP tool as a SWAIG tool. */
419
- private async _discoverTools(): Promise<void> {
420
- this._discoveredTools = [];
421
-
422
- // If no services configured, fetch all available
423
- let services = this.services;
424
- if (services.length === 0) {
425
- const response = await this._makeRequest(
426
- 'GET',
427
- `${this.gatewayUrl}/services`,
428
- );
429
- if (!response.ok) {
430
- log.error('mcp_gateway: failed to list services', {
431
- status: response.status,
432
- });
433
- return;
434
- }
435
- const allServices = (await response.json()) as Record<string, unknown>;
436
- services = Object.keys(allServices).map((name) => ({ name }));
437
- this.services = services;
438
- }
439
-
440
- for (const serviceConfig of services) {
441
- const serviceName = serviceConfig?.name;
442
- if (!serviceName) continue;
443
-
444
- try {
445
- const response = await this._makeRequest(
446
- 'GET',
447
- `${this.gatewayUrl}/services/${encodeURIComponent(serviceName)}/tools`,
448
- );
449
- if (!response.ok) {
450
- log.error('mcp_gateway: failed to get tools for service', {
451
- service: serviceName,
452
- status: response.status,
453
- });
454
- continue;
455
- }
456
- const data = (await response.json()) as { tools?: McpToolDefinition[] };
457
- let tools = data.tools ?? [];
458
-
459
- // Filter tools if specified
460
- const toolFilter = serviceConfig.tools ?? '*';
461
- if (toolFilter !== '*' && Array.isArray(toolFilter)) {
462
- tools = tools.filter((t) => toolFilter.includes(t.name));
463
- }
464
-
465
- for (const toolDef of tools) {
466
- const registered = this._registerMcpTool(serviceName, toolDef);
467
- if (registered) this._discoveredTools.push(registered);
468
- }
469
- } catch (err) {
470
- log.error('mcp_gateway: error fetching tools for service', {
471
- service: serviceName,
472
- error: err instanceof Error ? err.message : String(err),
473
- });
474
- }
475
- }
476
- }
477
-
478
- /** Convert an MCP tool definition into a SWAIG-compatible `SkillToolDefinition`. */
479
- private _registerMcpTool(
480
- serviceName: string,
481
- toolDef: McpToolDefinition,
482
- ): SkillToolDefinition | null {
483
- const toolName = toolDef.name;
484
- if (!toolName) return null;
485
-
486
- const swaigName = `${this.toolPrefix}${serviceName}_${toolName}`;
487
-
488
- const inputSchema = toolDef.inputSchema ?? {};
489
- const properties = inputSchema.properties ?? {};
490
- const required = inputSchema.required ?? [];
491
-
492
- const swaigParams: Record<string, Record<string, unknown>> = {};
493
- for (const [propName, propDef] of Object.entries(properties)) {
494
- const paramDef: Record<string, unknown> = {
495
- type: propDef.type ?? 'string',
496
- description: propDef.description ?? '',
497
- };
498
- if (propDef.enum !== undefined) paramDef['enum'] = propDef.enum;
499
- if (propDef.default !== undefined && !required.includes(propName)) {
500
- paramDef['default'] = propDef.default;
501
- }
502
- swaigParams[propName] = paramDef;
503
- }
504
-
505
- log.info('mcp_gateway: registering SWAIG tool', { name: swaigName });
506
-
507
- return {
508
- name: swaigName,
509
- description: `[${serviceName}] ${toolDef.description ?? toolName}`,
510
- parameters: swaigParams,
511
- required,
512
- handler: async (
513
- args: Record<string, unknown>,
514
- rawData: Record<string, unknown>,
515
- ) => this._callMcpTool(serviceName, toolName, args, rawData),
516
- };
517
- }
518
-
519
- /** Call an MCP tool through the gateway, with retries. */
520
- private async _callMcpTool(
521
- serviceName: string,
522
- toolName: string,
523
- args: Record<string, unknown>,
524
- rawData: Record<string, unknown>,
525
- ): Promise<FunctionResult> {
526
- const globalData = (rawData['global_data'] as Record<string, unknown>) ?? {};
527
- log.debug('mcp_gateway: raw_data keys', { keys: Object.keys(rawData) });
528
- log.debug('mcp_gateway: global_data keys', { keys: Object.keys(globalData) });
529
- let sessionId: string;
530
- if (typeof globalData['mcp_call_id'] === 'string') {
531
- sessionId = globalData['mcp_call_id'] as string;
532
- log.info('mcp_gateway: using session ID from global_data.mcp_call_id', {
533
- sessionId,
534
- });
535
- } else {
536
- sessionId = (rawData['call_id'] as string) ?? 'unknown';
537
- log.info('mcp_gateway: using session ID from call_id', { sessionId });
538
- }
539
- // NB: do NOT mutate this.sessionId here — Python leaves self.session_id
540
- // untouched after setup(). Per-call IDs stay local so concurrent tool
541
- // calls don't race and overwrite each other's session metadata.
542
-
543
- const requestData: Record<string, unknown> = {
544
- tool: toolName,
545
- arguments: args,
546
- session_id: sessionId,
547
- timeout: this.sessionTimeout,
548
- metadata: {
549
- // Python sends self.agent.name; mirror that and fall back to the
550
- // skill name when agent is not yet bound. No hardcoded SDK literal.
551
- agent_id: this.agent?.name ?? this.skillName,
552
- timestamp: rawData['timestamp'],
553
- call_id: rawData['call_id'],
554
- },
555
- };
556
-
557
- let lastError: string | undefined;
558
- for (let attempt = 0; attempt < this.retryAttempts; attempt++) {
559
- try {
560
- const response = await this._makeRequest(
561
- 'POST',
562
- `${this.gatewayUrl}/services/${encodeURIComponent(serviceName)}/call`,
563
- { body: requestData },
564
- );
565
-
566
- if (response.status === 200) {
567
- const resultData = (await response.json()) as {
568
- result?: unknown;
569
- };
570
- // Python returns result_data.get('result', 'No response') which yields
571
- // the raw string 'No response' when the key is missing. Preserve that:
572
- // only stringify when the value is defined and non-string.
573
- let resultText: string;
574
- if (typeof resultData.result === 'string') {
575
- resultText = resultData.result;
576
- } else if (resultData.result != null) {
577
- resultText = JSON.stringify(resultData.result);
578
- } else {
579
- resultText = 'No response';
580
- }
581
- return new FunctionResult(resultText);
582
- }
583
-
584
- let errorMsg: string;
585
- try {
586
- const errorData = (await response.json()) as { error?: string };
587
- errorMsg = errorData.error ?? `HTTP ${response.status}`;
588
- } catch {
589
- // Python includes the first 200 chars of the response body when the
590
- // payload isn't valid JSON (skill.py error handler). Match that.
591
- const bodyText = await response.text().catch(() => '');
592
- errorMsg = bodyText
593
- ? `HTTP ${response.status}: ${bodyText.slice(0, 200)}`
594
- : `HTTP ${response.status}`;
595
- }
596
- lastError = errorMsg;
597
-
598
- if (response.status >= 500) {
599
- log.warn('mcp_gateway: server error, retrying', {
600
- attempt: attempt + 1,
601
- error: errorMsg,
602
- });
603
- continue;
604
- }
605
- // Client error — don't retry
606
- break;
607
- } catch (err) {
608
- lastError = err instanceof Error ? err.message : String(err);
609
- // Distinguish network/timeout errors (retriable) from programming
610
- // errors like JSON parse failures on success responses (fatal).
611
- // Python aborts the retry loop on non-network exceptions; mirror that.
612
- const isNetwork =
613
- err instanceof Error &&
614
- (err.name === 'AbortError' ||
615
- err.name === 'TypeError' ||
616
- err.message.includes('fetch'));
617
- if (!isNetwork) {
618
- log.error('mcp_gateway: unexpected error, aborting retry', {
619
- attempt: attempt + 1,
620
- error: lastError,
621
- });
622
- break;
623
- }
624
- log.warn('mcp_gateway: request error', {
625
- attempt: attempt + 1,
626
- error: lastError,
627
- });
628
- }
629
- }
630
-
631
- const errorMsg = `Failed to call ${serviceName}.${toolName}: ${lastError ?? 'unknown error'}`;
632
- log.error('mcp_gateway: call failed', { error: errorMsg });
633
- return new FunctionResult(errorMsg);
634
- }
635
-
636
- /** Handle call hangup — clean up any MCP session on the gateway. */
637
- private async _hangupHandler(
638
- _args: Record<string, unknown>,
639
- rawData: Record<string, unknown>,
640
- ): Promise<FunctionResult> {
641
- const globalData = (rawData['global_data'] as Record<string, unknown>) ?? {};
642
- const sessionId =
643
- (globalData['mcp_call_id'] as string | undefined) ??
644
- (rawData['call_id'] as string | undefined) ??
645
- 'unknown';
646
-
647
- try {
648
- const response = await this._makeRequest(
649
- 'DELETE',
650
- `${this.gatewayUrl}/sessions/${encodeURIComponent(sessionId)}`,
651
- );
652
-
653
- if (response.status === 200 || response.status === 404) {
654
- log.info('mcp_gateway: cleaned up MCP session', { sessionId });
655
- } else {
656
- log.warn('mcp_gateway: session cleanup returned non-ok status', {
657
- status: response.status,
658
- });
659
- }
660
- } catch (err) {
661
- log.error('mcp_gateway: error cleaning up session', {
662
- error: err instanceof Error ? err.message : String(err),
663
- });
664
- }
665
-
666
- return new FunctionResult('Session cleanup complete');
667
- }
668
- }
669
-
670
- /**
671
- * Factory function for creating McpGatewaySkill instances.
672
- * @param config - Optional skill configuration.
673
- * @returns A new McpGatewaySkill instance.
674
- */
675
- export function createSkill(config?: SkillConfig): McpGatewaySkill {
676
- return new McpGatewaySkill(config);
677
- }