docs.json 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. {
  2. "$schema": "https://mintlify.com/docs.json",
  3. "theme": "maple",
  4. "name": "Agency Swarm",
  5. "colors": {
  6. "primary": "#fcd53b",
  7. "light": "#fcd53b",
  8. "dark": "#B76E00"
  9. },
  10. "favicon": "/images/favicon.svg",
  11. "navigation": {
  12. "tabs": [
  13. {
  14. "tab": "Framework",
  15. "global": {
  16. "anchors": [
  17. {
  18. "anchor": "Discord Community",
  19. "href": "https://discord.gg/cw2xBaWfFM",
  20. "icon": "discourse"
  21. },
  22. {
  23. "anchor": "Changelog",
  24. "href": "https://github.com/VRSEN/agency-swarm/releases",
  25. "icon": "timeline"
  26. }
  27. ]
  28. },
  29. "groups": [
  30. {
  31. "group": "Welcome",
  32. "pages": [
  33. "welcome/overview",
  34. "welcome/ai-agency-vs-other-frameworks",
  35. {
  36. "group": "Get Started",
  37. "icon": "rocket",
  38. "pages": [
  39. "welcome/installation",
  40. "welcome/getting-started/starter-template",
  41. "welcome/getting-started/cursor-ide",
  42. "welcome/getting-started/from-scratch"
  43. ]
  44. }
  45. ]
  46. },
  47. {
  48. "group": "Core Framework",
  49. "pages": [
  50. {
  51. "group": "Tools",
  52. "icon": "wrench",
  53. "pages": [
  54. "core-framework/tools/overview",
  55. "core-framework/tools/built-in-tools",
  56. {
  57. "group": "Custom Tools",
  58. "icon": "hammer",
  59. "pages": [
  60. "core-framework/tools/custom-tools/step-by-step-guide",
  61. "core-framework/tools/custom-tools/pydantic-is-all-you-need",
  62. "core-framework/tools/custom-tools/validation",
  63. "core-framework/tools/custom-tools/multimodal-outputs",
  64. "core-framework/tools/custom-tools/best-practices",
  65. "core-framework/tools/custom-tools/configuration"
  66. ]
  67. },
  68. "core-framework/tools/openapi-schemas",
  69. "core-framework/tools/mcp-integration"
  70. ]
  71. },
  72. {
  73. "group": "Agents",
  74. "icon": "user",
  75. "pages": [
  76. "core-framework/agents/overview",
  77. "core-framework/agents/built-in-tools",
  78. "core-framework/agents/advanced-configuration"
  79. ]
  80. },
  81. {
  82. "group": "Third-Party Agents",
  83. "icon": "plug",
  84. "pages": [
  85. "core-framework/third-party-agents/overview",
  86. "core-framework/third-party-agents/openclaw-agent"
  87. ]
  88. },
  89. {
  90. "group": "Agencies",
  91. "icon": "sitemap",
  92. "pages": [
  93. "core-framework/agencies/overview",
  94. "core-framework/agencies/communication-flows",
  95. "core-framework/agencies/running-agency",
  96. "core-framework/agencies/agent-swarm-cli",
  97. "core-framework/agencies/visualization"
  98. ]
  99. }
  100. ]
  101. },
  102. {
  103. "group": "Additional Features",
  104. "pages": [
  105. "additional-features/agency-context",
  106. "additional-features/few-shot-examples",
  107. {
  108. "group": "Guardrails",
  109. "icon": "shield-halved",
  110. "pages": [
  111. "additional-features/guardrails/overview",
  112. "additional-features/guardrails/input-guardrails",
  113. "additional-features/guardrails/output-guardrails"
  114. ]
  115. },
  116. "additional-features/streaming",
  117. "additional-features/fastapi-integration",
  118. "additional-features/mcp-tools-server",
  119. {
  120. "group": "Custom Communication Flows",
  121. "icon": "comments",
  122. "pages": [
  123. "additional-features/custom-communication-flows/overview",
  124. "additional-features/custom-communication-flows/common-use-cases"
  125. ]
  126. },
  127. "additional-features/azure-openai",
  128. "additional-features/third-party-models",
  129. "additional-features/deployment-to-production",
  130. "additional-features/observability"
  131. ]
  132. },
  133. {
  134. "group": "References",
  135. "pages": ["references/api"]
  136. },
  137. {
  138. "group": "Contributing",
  139. "pages": ["contributing/contributing"]
  140. },
  141. {
  142. "group": "Migration",
  143. "pages": ["migration/guide"]
  144. },
  145. {
  146. "group": "FAQ",
  147. "pages": ["faq"]
  148. }
  149. ]
  150. },
  151. {
  152. "tab": "Platform",
  153. "global": {
  154. "anchors": [
  155. {
  156. "anchor": "Agencii Platform",
  157. "href": "https://agencii.ai/signup/",
  158. "icon": "globe"
  159. },
  160. {
  161. "anchor": "Skool Community",
  162. "href": "https://www.skool.com/agency-ai/about",
  163. "icon": "users"
  164. }
  165. ]
  166. },
  167. "groups": [
  168. {
  169. "group": "Introduction",
  170. "pages": ["platform/overview", "platform/pricing", "platform/how-credits-work"]
  171. },
  172. {
  173. "group": "Integrations",
  174. "pages": [
  175. "platform/integrations/slack-integration",
  176. "platform/integrations/whatsapp-integration",
  177. "platform/integrations/zapier-integration",
  178. "platform/integrations/n8n-integration",
  179. "platform/integrations/web-api",
  180. "platform/integrations/widget"
  181. ]
  182. },
  183. {
  184. "group": "Marketplace",
  185. "icon": "store",
  186. "pages": [
  187. "platform/marketplace/openclaw",
  188. "platform/marketplace/onboarding"
  189. ]
  190. },
  191. {
  192. "group": "Additional Features",
  193. "pages": ["platform/additional-instructions"]
  194. }
  195. ],
  196. "openapi": {
  197. "source": "/openapi.json",
  198. "directory": "platform/integrations/api"
  199. }
  200. },
  201. {
  202. "tab": "Extras",
  203. "groups": [
  204. {
  205. "group": "Extras",
  206. "pages": ["extras/extras"]
  207. },
  208. {
  209. "group": "Tutorials",
  210. "pages": ["tutorials/tutorials"]
  211. }
  212. ]
  213. }
  214. ]
  215. },
  216. "logo": {
  217. "light": "/images/logo-light.svg",
  218. "dark": "/images/logo-dark.svg",
  219. "href": "https://agency-swarm.ai"
  220. },
  221. "appearance": {
  222. "default": "dark",
  223. "strict": false
  224. },
  225. "background": {
  226. "color": {
  227. "dark": "#0C102D"
  228. }
  229. },
  230. "navbar": {
  231. "primary": {
  232. "type": "github",
  233. "href": "https://github.com/VRSEN/agency-swarm"
  234. }
  235. },
  236. "search": {
  237. "prompt": "Search Agency Swarm docs"
  238. },
  239. "seo": {
  240. "indexing": "navigable"
  241. },
  242. "footer": {
  243. "socials": {
  244. "website": "https://vrsen.ai",
  245. "x": "https://x.com/__vrsen__",
  246. "github": "https://github.com/VRSEN/agency-swarm",
  247. "youtube": "https://youtube.com/@vrsen"
  248. }
  249. }
  250. }