@signalwire/sdk 2.0.1 → 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 (610) 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/{src/index.ts → dist/index.d.ts} +13 -100
  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/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  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/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  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 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  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 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  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/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,857 +0,0 @@
1
- # Skills System Guide
2
-
3
- Complete guide to the Skills system in the SignalWire AI Agents TypeScript SDK -- modular, reusable capabilities that can be added to any agent.
4
-
5
- ---
6
-
7
- ## Table of Contents
8
-
9
- 1. [Overview](#overview)
10
- 2. [Using Skills](#using-skills)
11
- 3. [Built-in Skills (19)](#built-in-skills-18)
12
- 4. [Skill Configuration](#skill-configuration)
13
- 5. [Skill Registry](#skill-registry)
14
- 6. [Creating Custom Skills](#creating-custom-skills)
15
- 7. [Skill Lifecycle](#skill-lifecycle)
16
- 8. [Environment Validation](#environment-validation)
17
-
18
- ---
19
-
20
- ## Overview
21
-
22
- Skills are **modular capabilities** that can be added to an agent at runtime. Each skill encapsulates one or more SWAIG tools, prompt sections, speech recognition hints, and global data -- everything needed to give an agent a new ability.
23
-
24
- The skills system is built on three core classes:
25
-
26
- | Class | Role | Location |
27
- |---|---|---|
28
- | `SkillBase` | Abstract base class that all skills extend | `src/skills/SkillBase.ts` |
29
- | `SkillManager` | Manages the lifecycle of skills attached to an agent | `src/skills/SkillManager.ts` |
30
- | `SkillRegistry` | Global singleton registry for discovering and instantiating skills by name | `src/skills/SkillRegistry.ts` |
31
-
32
- **What a skill provides:**
33
-
34
- - **Tools** -- SWAIG function definitions (name, description, parameters, handler) registered with the agent.
35
- - **Prompt sections** -- Text injected into the agent's system prompt to instruct the AI on how to use the skill's tools.
36
- - **Hints** -- Speech recognition hints to improve ASR accuracy for skill-related vocabulary.
37
- - **Global data** -- Key-value pairs merged into the agent's global data store.
38
- - **Manifest** -- Metadata describing the skill's name, version, required environment variables, and configuration schema.
39
-
40
- ---
41
-
42
- ## Using Skills
43
-
44
- ### `agent.addSkill()`
45
-
46
- The primary way to add a skill to an agent. This is an async operation because skills may perform setup work (API connections, config validation, etc.):
47
-
48
- ```typescript
49
- import { AgentBase } from '@signalwire/sdk';
50
- import { DateTimeSkill, WebSearchSkill } from '@signalwire/sdk/skills/builtin';
51
-
52
- const agent = new AgentBase({ name: 'my-agent' });
53
-
54
- // Add skills (async)
55
- await agent.addSkill(new DateTimeSkill());
56
- await agent.addSkill(new WebSearchSkill({ num_results: 3 }));
57
- ```
58
-
59
- When `addSkill()` is called, the agent:
60
-
61
- 1. Validates the skill's required environment variables (warns if missing).
62
- 2. Calls `skill.setup()` for initialization.
63
- 3. Marks the skill as initialized.
64
- 4. Registers all tools from `skill.getTools()` with the agent via `defineTool()`.
65
- 5. Injects all prompt sections from `skill.getPromptSections()` into the agent's prompt.
66
- 6. Adds all hints from `skill.getHints()`.
67
- 7. Merges all global data from `skill.getGlobalData()`.
68
-
69
- ### `agent.removeSkill()`
70
-
71
- Remove a skill by its unique instance ID. Calls `cleanup()` on the skill before removal:
72
-
73
- ```typescript
74
- const removed = await agent.removeSkill('datetime-abc123-def456');
75
- // returns true if found and removed, false otherwise
76
- ```
77
-
78
- ### `agent.listSkills()`
79
-
80
- List all currently loaded skills with their metadata:
81
-
82
- ```typescript
83
- const skills = agent.listSkills();
84
- // Returns: [{ name: 'datetime', instanceId: 'datetime-abc123-def456', initialized: true }, ...]
85
-
86
- for (const skill of skills) {
87
- console.log(`${skill.name} (${skill.instanceId}) - initialized: ${skill.initialized}`);
88
- }
89
- ```
90
-
91
- ### `agent.hasSkill()`
92
-
93
- Check whether a skill with a given name is currently registered:
94
-
95
- ```typescript
96
- if (agent.hasSkill('web_search')) {
97
- console.log('Web search is available');
98
- }
99
- ```
100
-
101
- ---
102
-
103
- ## Built-in Skills (19)
104
-
105
- The SDK ships with 18 built-in skills organized into three tiers based on complexity and dependency requirements.
106
-
107
- ### Tier 1: Simple (No External Dependencies)
108
-
109
- These skills work out of the box with no API keys or configuration.
110
-
111
- | Skill Name | Class | Description | Tools | Required Env Vars | Config Options |
112
- |---|---|---|---|---|---|
113
- | `datetime` | `DateTimeSkill` | Current date/time with timezone support | `get_datetime` | None | None |
114
- | `math` | `MathSkill` | Safe mathematical expression evaluation | `calculate` | None | None |
115
- | `joke` | `JokeSkill` | Random jokes from built-in collection | `tell_joke` | None | None |
116
-
117
- **datetime** -- Provides the current date and time in any IANA timezone via the `get_datetime` tool. Uses the `Intl.DateTimeFormat` API.
118
-
119
- ```typescript
120
- import { DateTimeSkill } from '@signalwire/sdk/skills/builtin';
121
- await agent.addSkill(new DateTimeSkill());
122
- ```
123
-
124
- **math** -- Evaluates mathematical expressions safely using a sandboxed parser. Supports `+`, `-`, `*`, `/`, `^`, `%`, and parentheses. Only allows digits, operators, parentheses, decimal points, and spaces.
125
-
126
- ```typescript
127
- import { MathSkill } from '@signalwire/sdk/skills/builtin';
128
- await agent.addSkill(new MathSkill());
129
- ```
130
-
131
- **joke** -- Tells random jokes from a curated built-in collection. Categories: `general`, `programming`, `dad`.
132
-
133
- ```typescript
134
- import { JokeSkill } from '@signalwire/sdk/skills/builtin';
135
- await agent.addSkill(new JokeSkill());
136
- ```
137
-
138
- ---
139
-
140
- ### Tier 2: Single API (Simple External Integration)
141
-
142
- These skills integrate with a single external API or provide focused call-control features.
143
-
144
- | Skill Name | Class | Description | Tools | Required Env Vars | Config Options |
145
- |---|---|---|---|---|---|
146
- | `weather_api` | `WeatherApiSkill` | Current weather from OpenWeatherMap | `get_weather` | `WEATHER_API_KEY` | `units` |
147
- | `play_background_file` | `PlayBackgroundFileSkill` | Background audio playback during calls | `play_background`, `stop_background` | None | `default_file_url`, `allowed_domains` |
148
- | `swml_transfer` | `SwmlTransferSkill` | Call transfer via SWML actions | `transfer_call`, `list_transfer_destinations` | None | `patterns`, `allow_arbitrary`, `default_message` |
149
- | `api_ninjas_trivia` | `ApiNinjasTriviaSkill` | Trivia questions from API Ninjas | `get_trivia` | `API_NINJAS_KEY` | `default_category`, `reveal_answer` |
150
- | `info_gatherer` | `InfoGathererSkill` | Sequential question flow that stores answers in `global_data` | `start_questions`, `submit_answer` | None | `questions`, `prefix`, `completion_message` |
151
- | `custom_skills` | `CustomSkillsSkill` | User-defined tools from configuration | Dynamic (from config) | None | `tools`, `prompt_title`, `prompt_body` |
152
-
153
- **weather_api** -- Fetches current weather data from OpenWeatherMap. Supports metric, imperial, and standard units.
154
-
155
- ```typescript
156
- import { WeatherApiSkill } from '@signalwire/sdk/skills/builtin';
157
- await agent.addSkill(new WeatherApiSkill({ units: 'imperial' }));
158
- ```
159
-
160
- **play_background_file** -- Controls background audio playback during calls (hold music, ambient sounds). Supports domain restrictions for audio file URLs.
161
-
162
- ```typescript
163
- import { PlayBackgroundFileSkill } from '@signalwire/sdk/skills/builtin';
164
- await agent.addSkill(new PlayBackgroundFileSkill({
165
- default_file_url: 'https://example.com/hold-music.mp3',
166
- allowed_domains: ['example.com', 'cdn.example.com'],
167
- }));
168
- ```
169
-
170
- **swml_transfer** -- Transfers calls using SWML transfer actions. Supports named destination patterns and arbitrary transfers.
171
-
172
- ```typescript
173
- import { SwmlTransferSkill } from '@signalwire/sdk/skills/builtin';
174
- await agent.addSkill(new SwmlTransferSkill({
175
- patterns: [
176
- { name: 'billing', destination: '+15551234567', description: 'Billing department' },
177
- { name: 'support', destination: 'sip:support@example.com', description: 'Technical support' },
178
- ],
179
- allow_arbitrary: false,
180
- default_message: 'Please hold while I transfer you.',
181
- }));
182
- ```
183
-
184
- **api_ninjas_trivia** -- Fetches trivia questions with optional category filtering. Categories include `general`, `sciencenature`, `entertainment`, `historyholidays`, `geography`, `music`, `mathematics`, and more.
185
-
186
- ```typescript
187
- import { ApiNinjasTriviaSkill } from '@signalwire/sdk/skills/builtin';
188
- await agent.addSkill(new ApiNinjasTriviaSkill({
189
- default_category: 'sciencenature',
190
- reveal_answer: false, // AI quizzes the user
191
- }));
192
- ```
193
-
194
- **info_gatherer** -- Guides the agent through a sequence of questions, collecting answers one at a time and storing them under a namespaced key in SWAIG `global_data`. Questions may require the agent to read the answer back to the user for confirmation before proceeding. Matches Python's `InfoGathererSkill` exactly; configure a `prefix` to run multiple instances side by side.
195
-
196
- ```typescript
197
- import { InfoGathererSkill } from '@signalwire/sdk/skills/builtin';
198
- await agent.addSkill(new InfoGathererSkill({
199
- questions: [
200
- { key_name: 'full_name', question_text: 'What is your full name?' },
201
- { key_name: 'email', question_text: 'What is your email address?', confirm: true },
202
- { key_name: 'reason', question_text: 'How can I help you today?' },
203
- ],
204
- completion_message: 'Thank you! Your information has been saved.',
205
- }));
206
- ```
207
-
208
- **custom_skills** -- A meta-skill that registers user-defined tools from configuration without writing skill classes. Handler code is compiled via the `Function` constructor at instantiation time.
209
-
210
- ```typescript
211
- import { CustomSkillsSkill } from '@signalwire/sdk/skills/builtin';
212
- await agent.addSkill(new CustomSkillsSkill({
213
- prompt_title: 'Greeting Tools',
214
- tools: [
215
- {
216
- name: 'get_greeting',
217
- description: 'Get a personalized greeting for a customer.',
218
- parameters: [
219
- { name: 'name', type: 'string', description: 'Customer name', required: true },
220
- ],
221
- handler_code: 'return new FunctionResult(`Hello, ${args.name}! Welcome back.`);',
222
- required: ['name'],
223
- },
224
- ],
225
- }));
226
- ```
227
-
228
- ---
229
-
230
- ### Tier 3: Complex (Multi-API or Advanced)
231
-
232
- These skills involve complex integrations, multiple API calls, or advanced processing.
233
-
234
- | Skill Name | Class | Description | Tools | Required Env Vars | Config Options |
235
- |---|---|---|---|---|---|
236
- | `web_search` | `WebSearchSkill` | Google Custom Search | `web_search` | `GOOGLE_SEARCH_API_KEY`, `GOOGLE_SEARCH_ENGINE_ID` | `num_results`, `tool_name`, `no_results_message`, `safe_search`, `delay`, `max_content_length`, `oversample_factor`, `min_quality_score` |
237
- | `wikipedia_search` | `WikipediaSearchSkill` | Wikipedia article summaries | `search_wiki` | None | `num_results`, `no_results_message`, `language`, `max_content_length` |
238
- | `google_maps` | `GoogleMapsSkill` | Directions and place search | `get_directions`, `find_place` | `GOOGLE_MAPS_API_KEY` | `default_mode` |
239
- | `datasphere` | `DataSphereSkill` | SignalWire DataSphere semantic search | `search_datasphere` | `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_TOKEN`, `SIGNALWIRE_SPACE` | `count`, `distance`, `document_id`, `tags`, `language`, `pos_to_expand`, `max_synonyms`, `no_results_message` |
240
- | `datasphere_serverless` | `DataSphereServerlessSkill` | DataSphere via server-side DataMap | `search_datasphere` | `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_TOKEN`, `SIGNALWIRE_SPACE` | `count`, `distance`, `document_id`, `tags`, `language`, `pos_to_expand`, `max_synonyms`, `no_results_message` |
241
- | `native_vector_search` | `NativeVectorSearchSkill` | In-memory TF-IDF document search | `search_documents` | None | `documents` |
242
- | `spider` | `SpiderSkill` | Web page scraping via Spider API | `scrape_url` | `SPIDER_API_KEY` | `max_content_length` |
243
- | `claude_skills` | `ClaudeSkillsSkill` | Load Claude SKILL.md files as tools | (dynamic) | None | `skills_path`, `include`, `exclude`, `tool_prefix` |
244
- | `ask_claude` | `AskClaudeSkill` | Anthropic Claude AI sub-queries | `ask_claude` | `ANTHROPIC_API_KEY` | `model`, `max_tokens` |
245
- | `mcp_gateway` | `McpGatewaySkill` | MCP protocol gateway (placeholder) | `mcp_invoke` | None | None |
246
-
247
- **web_search** -- Searches the web using Google Custom Search JSON API. Returns formatted results with titles, links, and snippets.
248
-
249
- ```typescript
250
- import { WebSearchSkill } from '@signalwire/sdk/skills/builtin';
251
- await agent.addSkill(new WebSearchSkill({
252
- num_results: 5,
253
- safe_search: 'medium', // 'off' | 'medium' | 'high'
254
- }));
255
- ```
256
-
257
- **wikipedia_search** -- Searches Wikipedia for article summaries and extracts. Uses the Wikipedia REST API with no API key required. Falls back to the search API if direct page lookup fails.
258
-
259
- ```typescript
260
- import { WikipediaSearchSkill } from '@signalwire/sdk/skills/builtin';
261
- await agent.addSkill(new WikipediaSearchSkill());
262
- ```
263
-
264
- **google_maps** -- Provides driving/walking/bicycling/transit directions and place search via Google Maps APIs (Directions API and Places Find Place API).
265
-
266
- ```typescript
267
- import { GoogleMapsSkill } from '@signalwire/sdk/skills/builtin';
268
- await agent.addSkill(new GoogleMapsSkill({ default_mode: 'walking' }));
269
- ```
270
-
271
- **datasphere** -- Searches SignalWire DataSphere for knowledge base content using semantic search across uploaded documents. Results are ranked by relevance score.
272
-
273
- ```typescript
274
- import { DataSphereSkill } from '@signalwire/sdk/skills/builtin';
275
- await agent.addSkill(new DataSphereSkill({
276
- document_id: 'my-doc-id',
277
- count: 5,
278
- distance: 3.0, // 0-10, lower is more similar
279
- }));
280
- ```
281
-
282
- **datasphere_serverless** -- Like `datasphere`, but uses a server-side DataMap instead of a webhook handler. The search executes entirely on the SignalWire platform, making it ideal for serverless or edge deployments where no webhook endpoint is available.
283
-
284
- ```typescript
285
- import { DataSphereServerlessSkill } from '@signalwire/sdk/skills/builtin';
286
- await agent.addSkill(new DataSphereServerlessSkill({
287
- document_id: 'specific-doc-id',
288
- count: 5,
289
- distance: 3.0, // 0-10, lower is more similar
290
- }));
291
- ```
292
-
293
- **native_vector_search** -- In-memory document search using TF-IDF-like word overlap scoring. Documents are provided via configuration and indexed at construction time. No external dependencies or API keys required. Suitable for small to medium document collections.
294
-
295
- ```typescript
296
- import { NativeVectorSearchSkill } from '@signalwire/sdk/skills/builtin';
297
- await agent.addSkill(new NativeVectorSearchSkill({
298
- documents: [
299
- { id: 'faq-1', text: 'To reset your password, go to Settings > Security > Change Password.' },
300
- { id: 'faq-2', text: 'Our business hours are Monday-Friday 9am-5pm EST.' },
301
- { id: 'faq-3', text: 'Refunds are processed within 5-7 business days.', metadata: { category: 'billing' } },
302
- ],
303
- }));
304
- ```
305
-
306
- **spider** -- Scrapes webpage content using the Spider API. Extracts text, markdown, or HTML from any public URL with optional CSS selector filtering.
307
-
308
- ```typescript
309
- import { SpiderSkill } from '@signalwire/sdk/skills/builtin';
310
- await agent.addSkill(new SpiderSkill({
311
- max_content_length: 5000,
312
- }));
313
- ```
314
-
315
- **claude_skills** -- Loads Claude Code SKILL.md files from a directory and converts them into SWAIG tools. Each skill directory contains a `SKILL.md` with YAML frontmatter (name, description) and markdown instructions. Supports argument substitution, variable replacement, optional shell injection, and invocation control.
316
-
317
- ```typescript
318
- import { ClaudeSkillsSkill } from '@signalwire/sdk/skills/builtin';
319
- await agent.addSkill(new ClaudeSkillsSkill({
320
- skills_path: '/path/to/skills',
321
- include: ['*'],
322
- exclude: [],
323
- tool_prefix: 'claude_',
324
- }));
325
- ```
326
-
327
- **ask_claude** -- Provides access to Anthropic's Claude AI for sub-queries, complex reasoning, analysis, or summarization. The agent can delegate tasks to Claude when deeper processing is needed.
328
-
329
- ```typescript
330
- import { AskClaudeSkill } from '@signalwire/sdk/skills/builtin';
331
- await agent.addSkill(new AskClaudeSkill({
332
- model: 'claude-sonnet-4-5-20250929',
333
- max_tokens: 1024,
334
- }));
335
- ```
336
-
337
- **mcp_gateway** -- Placeholder skill for future Model Context Protocol (MCP) server integration. Currently provides a non-functional `mcp_invoke` tool. Version 0.1.0 (stub).
338
-
339
- ```typescript
340
- import { McpGatewaySkill } from '@signalwire/sdk/skills/builtin';
341
- await agent.addSkill(new McpGatewaySkill());
342
- ```
343
-
344
- ---
345
-
346
- ## Skill Configuration
347
-
348
- Skills accept configuration via a `SkillConfig` key-value object passed to the constructor:
349
-
350
- ```typescript
351
- interface SkillConfig {
352
- [key: string]: unknown;
353
- }
354
- ```
355
-
356
- ### Accessing Config in Skills
357
-
358
- Skills use `this.getConfig<T>(key, defaultValue)` to read configuration values with type safety and defaults:
359
-
360
- ```typescript
361
- // Inside a skill class
362
- const maxResults = this.getConfig<number>('max_results', 5);
363
- const safeSearch = this.getConfig<string>('safe_search', 'medium');
364
- const patterns = this.getConfig<TransferPattern[]>('patterns', []);
365
- ```
366
-
367
- ### Config Schema in Manifests
368
-
369
- Skills declare their expected configuration in the manifest's `configSchema` field. This is a JSON-schema-like description used for documentation and tooling:
370
-
371
- ```typescript
372
- getManifest(): SkillManifest {
373
- return {
374
- name: 'my_skill',
375
- description: 'Does something useful.',
376
- version: '1.0.0',
377
- configSchema: {
378
- max_results: {
379
- type: 'number',
380
- description: 'Maximum number of results to return.',
381
- default: 5,
382
- },
383
- safe_search: {
384
- type: 'string',
385
- description: 'Safe search level: "off", "medium", or "high".',
386
- default: 'medium',
387
- },
388
- },
389
- };
390
- }
391
- ```
392
-
393
- ---
394
-
395
- ## Skill Registry
396
-
397
- The `SkillRegistry` is a global singleton that maps skill names to factory functions. It enables skill discovery and instantiation by name.
398
-
399
- ### Getting the Registry
400
-
401
- ```typescript
402
- import { SkillRegistry } from '@signalwire/sdk/skills';
403
-
404
- const registry = SkillRegistry.getInstance();
405
- ```
406
-
407
- ### Registering Built-in Skills
408
-
409
- All 18 built-in skills can be registered at once:
410
-
411
- ```typescript
412
- import { registerBuiltinSkills } from '@signalwire/sdk/skills/builtin';
413
-
414
- registerBuiltinSkills();
415
- // Now all built-in skills are available via registry.create('datetime'), etc.
416
- ```
417
-
418
- This function skips registration for any skill name already present, so it is safe to call multiple times.
419
-
420
- ### Manual Registration
421
-
422
- Register a custom skill factory:
423
-
424
- ```typescript
425
- registry.register('my_custom_skill', (config) => new MyCustomSkill(config));
426
- ```
427
-
428
- Register with a manifest for introspection:
429
-
430
- ```typescript
431
- registry.register('my_custom_skill', (config) => new MyCustomSkill(config), {
432
- name: 'my_custom_skill',
433
- description: 'Does custom things.',
434
- version: '1.0.0',
435
- });
436
- ```
437
-
438
- ### Creating Instances by Name
439
-
440
- ```typescript
441
- const skill = registry.create('datetime');
442
- if (skill) {
443
- await agent.addSkill(skill);
444
- }
445
-
446
- // With config
447
- const weatherSkill = registry.create('weather_api', { units: 'imperial' });
448
- ```
449
-
450
- Returns `null` if the skill name is not registered.
451
-
452
- ### Querying the Registry
453
-
454
- ```typescript
455
- // Check if a skill is registered
456
- registry.has('datetime'); // true
457
-
458
- // List all registered skill names
459
- const names = registry.listRegistered();
460
- // ['datetime', 'math', 'joke', ...]
461
-
462
- // List with manifests
463
- const withManifests = registry.listRegisteredWithManifests();
464
- // [{ name: 'datetime', manifest: { ... } }, ...]
465
-
466
- // Get a specific manifest
467
- const manifest = registry.getManifest('web_search');
468
-
469
- // Count of registered skills
470
- const count = registry.size;
471
- ```
472
-
473
- ### Skill Discovery from Directories
474
-
475
- The registry can auto-discover skills from filesystem directories:
476
-
477
- ```typescript
478
- // Add a search path
479
- registry.addSearchPath('/path/to/my/skills');
480
-
481
- // Discover and register skills from a specific directory
482
- const discovered = await registry.discoverFromDirectory('/path/to/my/skills');
483
- // Returns array of newly discovered skill names
484
-
485
- // Discover from all configured search paths
486
- const allDiscovered = await registry.discoverAll();
487
- ```
488
-
489
- Discovery looks for modules that export either:
490
- - A `createSkill` factory function, or
491
- - A default export that is a `SkillBase` subclass
492
-
493
- The `SIGNALWIRE_SKILL_PATHS` environment variable can set additional search paths (colon-separated):
494
-
495
- ```bash
496
- export SIGNALWIRE_SKILL_PATHS="/app/skills:/shared/skills"
497
- ```
498
-
499
- ### Cleanup
500
-
501
- ```typescript
502
- // Unregister a single skill
503
- registry.unregister('my_skill');
504
-
505
- // Clear all registrations
506
- registry.clear();
507
-
508
- // Reset the singleton (for testing)
509
- SkillRegistry.resetInstance();
510
- ```
511
-
512
- ---
513
-
514
- ## Creating Custom Skills
515
-
516
- To create a custom skill, extend `SkillBase` and implement the required abstract methods.
517
-
518
- ### Minimal Custom Skill
519
-
520
- ```typescript
521
- import { SkillBase, SkillManifest, SkillToolDefinition, SkillConfig } from '@signalwire/sdk/skills';
522
- import { FunctionResult } from '@signalwire/sdk';
523
-
524
- export class GreetingSkill extends SkillBase {
525
- constructor(config?: SkillConfig) {
526
- super('greeting', config);
527
- }
528
-
529
- getManifest(): SkillManifest {
530
- return {
531
- name: 'greeting',
532
- description: 'Provides personalized greetings.',
533
- version: '1.0.0',
534
- author: 'My Team',
535
- tags: ['utility', 'greeting'],
536
- };
537
- }
538
-
539
- getTools(): SkillToolDefinition[] {
540
- const style = this.getConfig<string>('style', 'formal');
541
-
542
- return [
543
- {
544
- name: 'greet_customer',
545
- description: 'Generate a personalized greeting for a customer.',
546
- parameters: {
547
- name: {
548
- type: 'string',
549
- description: 'The customer name.',
550
- },
551
- },
552
- required: ['name'],
553
- handler: (args: Record<string, unknown>) => {
554
- const name = args.name as string;
555
- if (style === 'casual') {
556
- return new FunctionResult(`Hey ${name}! What's up?`);
557
- }
558
- return new FunctionResult(`Good day, ${name}. How may I assist you?`);
559
- },
560
- },
561
- ];
562
- }
563
- }
564
-
565
- // Factory function (required for registry discovery)
566
- export function createSkill(config?: SkillConfig): GreetingSkill {
567
- return new GreetingSkill(config);
568
- }
569
- ```
570
-
571
- ### Full-Featured Custom Skill
572
-
573
- ```typescript
574
- import {
575
- SkillBase,
576
- SkillManifest,
577
- SkillToolDefinition,
578
- SkillPromptSection,
579
- SkillConfig,
580
- } from '@signalwire/sdk/skills';
581
- import { FunctionResult } from '@signalwire/sdk';
582
-
583
- export class InventorySkill extends SkillBase {
584
- private db: Map<string, number> = new Map();
585
-
586
- constructor(config?: SkillConfig) {
587
- super('inventory', config);
588
- }
589
-
590
- getManifest(): SkillManifest {
591
- return {
592
- name: 'inventory',
593
- description: 'Checks product inventory levels.',
594
- version: '1.0.0',
595
- author: 'Acme Corp',
596
- tags: ['inventory', 'products', 'e-commerce'],
597
- requiredEnvVars: ['INVENTORY_DB_URL'],
598
- configSchema: {
599
- low_stock_threshold: {
600
- type: 'number',
601
- description: 'Quantity below which a product is considered low stock.',
602
- default: 10,
603
- },
604
- },
605
- };
606
- }
607
-
608
- // Initialization -- called when the skill is added to an agent
609
- async setup(): Promise<void> {
610
- const dbUrl = process.env['INVENTORY_DB_URL'];
611
- // ... connect to database, load initial data ...
612
- this.db.set('widget-a', 150);
613
- this.db.set('widget-b', 3);
614
- }
615
-
616
- // Cleanup -- called when the skill is removed
617
- async cleanup(): Promise<void> {
618
- // ... close database connection ...
619
- this.db.clear();
620
- }
621
-
622
- getTools(): SkillToolDefinition[] {
623
- const threshold = this.getConfig<number>('low_stock_threshold', 10);
624
-
625
- return [
626
- {
627
- name: 'check_inventory',
628
- description: 'Check the current inventory level for a product.',
629
- parameters: {
630
- product_id: {
631
- type: 'string',
632
- description: 'The product ID to check.',
633
- },
634
- },
635
- required: ['product_id'],
636
- secure: true, // requires authenticated invocation
637
- fillers: {
638
- 'en-US': ['Let me check our stock levels...', 'One moment...'],
639
- },
640
- handler: (args: Record<string, unknown>) => {
641
- const productId = args.product_id as string;
642
- const quantity = this.db.get(productId);
643
-
644
- if (quantity === undefined) {
645
- return new FunctionResult(`Product "${productId}" not found in inventory.`);
646
- }
647
-
648
- const status = quantity <= threshold ? 'LOW STOCK' : 'In Stock';
649
- return new FunctionResult(
650
- `Product ${productId}: ${quantity} units available (${status}).`
651
- );
652
- },
653
- },
654
- ];
655
- }
656
-
657
- getPromptSections(): SkillPromptSection[] {
658
- return [
659
- {
660
- title: 'Inventory Lookup',
661
- body: 'You can check product inventory levels for customers.',
662
- bullets: [
663
- 'Use the check_inventory tool when a customer asks about product availability.',
664
- 'If a product is low stock, proactively let the customer know.',
665
- 'Suggest alternatives if a product is out of stock.',
666
- ],
667
- },
668
- ];
669
- }
670
-
671
- getHints(): string[] {
672
- return ['inventory', 'stock', 'availability', 'in stock', 'out of stock'];
673
- }
674
-
675
- getGlobalData(): Record<string, unknown> {
676
- return {
677
- inventory_skill_version: '1.0.0',
678
- low_stock_threshold: this.getConfig<number>('low_stock_threshold', 10),
679
- };
680
- }
681
- }
682
-
683
- export function createSkill(config?: SkillConfig): InventorySkill {
684
- return new InventorySkill(config);
685
- }
686
- ```
687
-
688
- ### SkillBase Methods Reference
689
-
690
- | Method | Required | Description |
691
- |---|---|---|
692
- | `getManifest()` | Yes (abstract) | Returns the skill manifest with name, description, version, env vars, and config schema |
693
- | `getTools()` | Yes (abstract) | Returns array of SWAIG tool definitions to register with the agent |
694
- | `setup()` | No | Async initialization hook called when the skill is added to an agent |
695
- | `cleanup()` | No | Async teardown hook called when the skill is removed |
696
- | `getPromptSections()` | No | Returns prompt sections injected into the agent's system prompt |
697
- | `getHints()` | No | Returns speech recognition hint strings |
698
- | `getGlobalData()` | No | Returns key-value data merged into the agent's global data store |
699
- | `validateEnvVars()` | No | Checks required env vars from manifest; returns array of missing names |
700
- | `getConfig(key, default)` | No | Reads a configuration value with type-safe default |
701
- | `isInitialized()` | No | Returns whether `setup()` has completed |
702
-
703
- ### SkillToolDefinition Fields
704
-
705
- | Field | Type | Required | Description |
706
- |---|---|---|---|
707
- | `name` | `string` | Yes | Unique tool name for SWAIG function registration |
708
- | `description` | `string` | Yes | Human-readable description shown to the AI |
709
- | `parameters` | `Record<string, unknown>` | No | Parameter schema keyed by parameter name |
710
- | `handler` | `SwaigHandler` | Yes | Function invoked when the tool is called |
711
- | `secure` | `boolean` | No | Whether the tool requires authenticated invocation |
712
- | `fillers` | `Record<string, string[]>` | No | Filler phrases spoken while the tool executes, keyed by language |
713
- | `required` | `string[]` | No | List of required parameter names |
714
-
715
- ### SkillPromptSection Fields
716
-
717
- | Field | Type | Required | Description |
718
- |---|---|---|---|
719
- | `title` | `string` | Yes | Section heading displayed in the prompt |
720
- | `body` | `string` | No | Body text for the section |
721
- | `bullets` | `string[]` | No | Bullet points appended after the body |
722
- | `numbered` | `boolean` | No | If true, render bullets as a numbered list |
723
-
724
- ---
725
-
726
- ## Skill Lifecycle
727
-
728
- The lifecycle of a skill follows these phases:
729
-
730
- ```
731
- Construction -> setup() -> register tools/prompts/hints -> active use -> cleanup()
732
- ```
733
-
734
- ### 1. Construction
735
-
736
- The skill is instantiated with a name and optional config. The `instanceId` is generated automatically (combination of skill name, timestamp, and random bytes):
737
-
738
- ```typescript
739
- const skill = new DateTimeSkill({ /* config */ });
740
- // skill.skillName === 'datetime'
741
- // skill.instanceId === 'datetime-m2abc123-deadbeef'
742
- // skill.isInitialized() === false
743
- ```
744
-
745
- ### 2. Setup
746
-
747
- When `agent.addSkill(skill)` is called, the `SkillManager`:
748
-
749
- 1. Checks for duplicate instance IDs.
750
- 2. Calls `skill.validateEnvVars()` and logs warnings for any missing environment variables.
751
- 3. Calls `await skill.setup()` for async initialization.
752
- 4. Calls `skill.markInitialized()`.
753
-
754
- ```typescript
755
- // Inside a custom skill
756
- async setup(): Promise<void> {
757
- // Connect to databases, validate API keys, pre-load data, etc.
758
- const apiKey = process.env['MY_API_KEY'];
759
- if (!apiKey) throw new Error('API key is required');
760
- this.client = await connectToService(apiKey);
761
- }
762
- ```
763
-
764
- ### 3. Registration
765
-
766
- After setup, the agent registers the skill's contributions:
767
-
768
- - **Tools** from `getTools()` are registered via `agent.defineTool()`.
769
- - **Prompt sections** from `getPromptSections()` are injected via `agent.promptAddSection()`.
770
- - **Hints** from `getHints()` are added via `agent.addHints()`.
771
- - **Global data** from `getGlobalData()` is merged via `agent.updateGlobalData()`.
772
-
773
- ### 4. Active Use
774
-
775
- The skill is now active. Its tools are called by the AI during conversations. The skill instance remains in memory for the lifetime of the agent.
776
-
777
- ### 5. Cleanup
778
-
779
- When `agent.removeSkill(instanceId)` is called (or the SkillManager is cleared), the skill's `cleanup()` method is invoked:
780
-
781
- ```typescript
782
- async cleanup(): Promise<void> {
783
- // Close connections, release resources, flush caches
784
- await this.client.disconnect();
785
- }
786
- ```
787
-
788
- The `SkillManager.clear()` method calls `cleanup()` on all loaded skills and removes them all.
789
-
790
- ---
791
-
792
- ## Environment Validation
793
-
794
- Skills can declare required environment variables in their manifest. The `validateEnvVars()` method checks which ones are missing.
795
-
796
- ### In the Manifest
797
-
798
- ```typescript
799
- getManifest(): SkillManifest {
800
- return {
801
- name: 'my_api_skill',
802
- description: 'Integrates with My API.',
803
- version: '1.0.0',
804
- requiredEnvVars: ['MY_API_KEY', 'MY_API_SECRET'],
805
- };
806
- }
807
- ```
808
-
809
- ### Automatic Validation
810
-
811
- When `addSkill()` is called, the `SkillManager` automatically validates env vars and logs warnings for any that are missing. The skill is still added even if env vars are missing -- it is up to the skill's handler to return appropriate error messages at call time.
812
-
813
- ### Manual Validation
814
-
815
- ```typescript
816
- const skill = new WebSearchSkill();
817
- const missing = skill.validateEnvVars();
818
-
819
- if (missing.length > 0) {
820
- console.warn(`Missing env vars: ${missing.join(', ')}`);
821
- }
822
- // missing might be ['GOOGLE_SEARCH_API_KEY', 'GOOGLE_SEARCH_ENGINE_ID']
823
- ```
824
-
825
- ### Runtime Handling
826
-
827
- Built-in skills check for environment variables at call time and return user-friendly error messages:
828
-
829
- ```typescript
830
- // Inside a tool handler
831
- const apiKey = process.env['GOOGLE_SEARCH_API_KEY'];
832
- if (!apiKey) {
833
- return new FunctionResult(
834
- 'Web search is not configured. The GOOGLE_SEARCH_API_KEY environment variable is required.'
835
- );
836
- }
837
- ```
838
-
839
- This two-layer approach (warn at registration, error at call time) allows agents to start up even when some skills are not fully configured, while providing clear feedback when an unconfigured tool is invoked.
840
-
841
- ---
842
-
843
- ## Complete Environment Variables Reference
844
-
845
- | Env Var | Used By |
846
- |---|---|
847
- | `WEATHER_API_KEY` | `weather_api` |
848
- | `API_NINJAS_KEY` | `api_ninjas_trivia` |
849
- | `GOOGLE_SEARCH_API_KEY` | `web_search` |
850
- | `GOOGLE_SEARCH_ENGINE_ID` | `web_search` |
851
- | `GOOGLE_MAPS_API_KEY` | `google_maps` |
852
- | `SIGNALWIRE_PROJECT_ID` | `datasphere`, `datasphere_serverless` |
853
- | `SIGNALWIRE_TOKEN` | `datasphere`, `datasphere_serverless` |
854
- | `SIGNALWIRE_SPACE` | `datasphere`, `datasphere_serverless` |
855
- | `SPIDER_API_KEY` | `spider` |
856
- | `ANTHROPIC_API_KEY` | `ask_claude` |
857
- | `SIGNALWIRE_SKILL_PATHS` | `SkillRegistry` (directory discovery) |