PageSourceSearch

https://fast-agent.ai/ref/generated_docs/

html fast-agent.ai collected 2026-10-04 00:18:56 UTC 68,463 bytes, 4,009 lines download raw bytes

1
2<!doctype html>
3<html lang="en" class="no-js">
4  <head>
5    
6      <meta charset="utf-8">
7      <meta name="viewport" content="width=device-width,initial-scale=1">
8      
9        <meta name="description" content="MCP-native agents, workflows, and servers">
10      
11      
12      
13        <link rel="canonical" href="https://fast-agent.ai/ref/generated_docs/">
14      
15      
16        <link rel="prev" href="../fast_agent_ai_articles/">
17      
18      
19        <link rel="next" href="../docs_automation/">
20      
21      
22        
23      
24      
25      <link rel="icon" href="../../assets/brand/fast-agent-icon.svg">
26      <meta name="generator" content="zensical-0.0.62">
27    
28    
29      
30        <title>Generated Docs - fast-agent documentation</title>
31      
32    
33    
34      
35        
36      
37      <link rel="stylesheet" href="../../assets/stylesheets/modern/main.ce62732f.min.css">
38      
39        
40          
41        
42        <link rel="stylesheet" href="../../assets/stylesheets/modern/palette.812a03bb.min.css">
43      
44      
45
46
47    
48    
49      
50    
51    
52<link rel="preconnect" href="https://fonts.googleapis.com" />
53<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
54<link
55  href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600;700&display=optional"
56  rel="stylesheet"
57/>
58<style>:root{--md-text-font:"JetBrains Mono";--md-code-font:"JetBrains Mono"}</style>
59
60    
61      <link rel="stylesheet" href="../../stylesheets/fast-agent.css">
62    
63      <link rel="stylesheet" href="../../assets/vendor/asciinema-player/asciinema-player.css">
64    
65      <link rel="stylesheet" href="../../assets/vendor/asciinema-player/catppuccin.css">
66    
67    
67<script>__md_scope=new URL("../..",location),__md_scope.pathname.endsWith("/")||(__md_scope=new URL(__md_scope.pathname+"/",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+"."+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+"."+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute("data-platform",navigator.platform)</script>
67
68    
69      
70
71    
72     
73       
74<meta
75  property="og:type"
76  content="article"
77/>
78<meta property="og:site_name" content="fast-agent documentation" />
79<meta property="og:title" content="Generated Reference Docs" />
80
81<meta property="og:description" content="Understand how generated API and model reference pages are produced." />
82 
83<meta property="og:url" content="https://fast-agent.ai/ref/generated_docs/" />
84
85<meta property="og:image" content="https://fast-agent.ai/assets/social/ref/generated_docs.png" />
86<meta property="og:image:secure_url" content="https://fast-agent.ai/assets/social/ref/generated_docs.png" />
87<meta property="og:image:type" content="image/png" />
88<meta property="og:image:width" content="1200" />
89<meta property="og:image:height" content="630" />
90<meta property="og:image:alt" content="fast-agent social card — Generated Reference Docs" />
91<meta name="twitter:card" content="summary_large_image" />
92<meta name="twitter:title" content="Generated Reference Docs" />
93
94<meta name="twitter:description" content="Understand how generated API and model reference pages are produced." />
95
96<meta name="twitter:image" content="https://fast-agent.ai/assets/social/ref/generated_docs.png" />
97
98 
99  </head>
100  
101  
102    
103    
104      
105    
106    
107    
108    
109    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">
110  
111    
112    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
113    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
114    <label class="md-overlay" for="__drawer" aria-label="Navigation"></label>
115    <div data-md-component="skip">
116      
117        
118        <a href="#generated-docs" class="md-skip">
119          Skip to content
120        </a>
121      
122    </div>
123    <div data-md-component="announce">
124      
125        <aside class="md-banner">
126          <div class="md-banner__inner md-grid md-typeset">
127            
128              <button class="md-banner__button md-icon" aria-label="Don't show this again">
129                
130                <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-x" viewBox="0 0 24 24"><path d="M18 6 6 18M6 6l12 12"/></svg>
131              </button>
132            
133             Join the <b>fast-agent</b> community on
134<strong><a href="https://discord.gg/xg5cJ7ndN6">Discord</a></strong>
135
136          </div>
137          
138            
138<script>var el=document.querySelector("[data-md-component=announce]");if(el){var content=el.querySelector(".md-typeset");__md_hash(content.innerHTML)===__md_get("__announce")&&(el.hidden=!0)}</script>
138
139          
140        </aside>
141      
142    </div>
143    
144    
145      
146
147<header class="md-header" data-md-component="header">
148  <nav class="md-header__inner md-grid" aria-label="Header">
149    <a href="../.." title="fast-agent documentation" class="md-header__button md-logo" aria-label="fast-agent documentation" data-md-component="logo">
150      
151  <img src="../../assets/brand/fast-agent-icon.svg" alt="fast-agent documentation">
152
153    </a>
154    <label class="md-header__button md-icon" for="__drawer" aria-label="Navigation">
155      
156      <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-menu" viewBox="0 0 24 24"><path d="M4 5h16M4 12h16M4 19h16"/></svg>
157    </label>
158    <div class="md-header__title" data-md-component="header-title">
159      <div class="md-header__ellipsis">
160        <div class="md-header__topic">
161          <span class="md-ellipsis">
162            fast-agent documentation
163          </span>
164        </div>
165        <div class="md-header__topic" data-md-component="header-topic">
166          <span class="md-ellipsis">
167            
168              Generated Docs
169            
170          </span>
171        </div>
172      </div>
173    </div>
174    
175      
176        <form class="md-header__option" data-md-component="palette">
177  
178    
179    
180    
181    <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_0">
182    
183      <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
184        <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sun-moon" viewBox="0 0 24 24"><path d="M12 2v2M14.837 16.385a6 6 0 1 1-7.223-7.222c.624-.147.97.66.715 1.248a4 4 0 0 0 5.26 5.259c.589-.255 1.396.09 1.248.715M16 12a4 4 0 0 0-4-4M19 5l-1.256 1.256M20 12h2"/></svg>
185      </label>
186    
187  
188    
189    
190    
191    <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_1">
192    
193      <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
194        <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-sun" viewBox="0 0 24 24"><circle cx="12" cy="12" r="4"/><path d="M12 2v2M12 20v2M4.93 4.93l1.41 1.41M17.66 17.66l1.41 1.41M2 12h2M20 12h2M6.34 17.66l-1.41 1.41M19.07 4.93l-1.41 1.41"/></svg>
195      </label>
196    
197  
198    
199    
200    
201    <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom"  aria-label="Switch to system preference"  type="radio" name="__palette" id="__palette_2">
202    
203      <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
204        <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-moon" viewBox="0 0 24 24"><path d="M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401"/></svg>
205      </label>
206    
207  
208</form>
209      
210    
211    
212      
212<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
212
213    
214    
215    
216      
217      
218        <label class="md-header__button md-icon" for="__search" aria-label="Search">
219          
220          <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-search" viewBox="0 0 24 24"><path d="m21 21-4.34-4.34"/><circle cx="11" cy="11" r="8"/></svg>
221        </label>
222        <div class="md-search" data-md-component="search" role="dialog" aria-label="Search">
223  <button type="button" class="md-search__button">
224    Search
225  </button>
226</div>
227      
228    
229    <div class="md-header__source">
230      
231        <a href="https://github.com/evalstate/fast-agent" title="Go to repository" class="md-source" data-md-component="source">
232  <div class="md-source__icon md-icon">
233    
234    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.--><path fill="currentColor" d="M216.5 362.5c-66-8-112.5-55.5-112.5-117 0-25 9-52 24-70-6.5-16.5-5.5-51.5 2-66 20-2.5 47 8 63 22.5 19-6 39-9 63.5-9s44.5 3 62.5 8.5c15.5-14 43-24.5 63-22 7 13.5 8 48.5 1.5 65.5 16 19 24.5 44.5 24.5 70.5 0 61.5-46.5 108-113.5 116.5 17 11 28.5 35 28.5 62.5v52c0 15 12.5 23.5 27.5 17.5C441 459.5 512 369 512 257 512 115.5 397 0 255.5 0S0 115.5 0 257c0 111 70.5 203 165.5 237.5 13.5 5 26.5-4 26.5-17.5v-40c-7 3-16 5-24 5-33 0-52.5-18-66.5-51.5-5.5-13.5-11.5-21.5-23-23-6-.5-8-3-8-6 0-6 10-10.5 20-10.5 14.5 0 27 9 40 27.5 10 14.5 20.5 21 33 21s20.5-4.5 32-16c8.5-8.5 15-16 21-21"/></svg>
235  </div>
236  <div class="md-source__repository">
237    evalstate/fast-agent
238  </div>
239</a>
240      
241    </div>
242  </nav>
243  
244</header>
245    
246    <div class="md-container" data-md-component="container">
247      
248      
249        
250          
251            
252<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
253  <div class="md-grid">
254    <ul class="md-tabs__list">
255      
256        
257  
258  
259  
260  
261    <li class="md-tabs__item">
262      <a href="../.." class="md-tabs__link">
263        
264  
265  fast-agent
266
267      </a>
268    </li>
269  
270
271      
272        
273  
274  
275  
276  
277    
278      
279    
280    
281    
282      <li class="md-tabs__item">
283        <a href="../../guides/core-concepts/" class="md-tabs__link">
284          
285  
286  Guides
287
288        </a>
289      </li>
290    
291  
292
293      
294        
295  
296  
297  
298  
299    
300      
301    
302    
303    
304      
305  
306  
307  
308  
309    
310      
311    
312    
313    
314      <li class="md-tabs__item">
315        <a href="../../agents/defining/" class="md-tabs__link">
316          
317  
318  Agents
319
320        </a>
321      </li>
322    
323  
324
325    
326  
327
328      
329        
330  
331  
332  
333  
334    
335      
336    
337    
338    
339      <li class="md-tabs__item">
340        <a href="../../models/" class="md-tabs__link">
341          
342  
343  Models
344
345        </a>
346      </li>
347    
348  
349
350      
351        
352  
353  
354  
355  
356    
357      
358    
359    
360    
361      
362  
363  
364  
365  
366    
367      
368    
369    
370    
371      <li class="md-tabs__item">
372        <a href="../../acp/" class="md-tabs__link">
373          
374  
375  ACP
376
377        </a>
378      </li>
379    
380  
381
382    
383  
384
385      
386        
387  
388  
389  
390  
391    
392      
393    
394    
395    
396      <li class="md-tabs__item">
397        <a href="../../a2a/getting-started/" class="md-tabs__link">
398          
399  
400  A2A
401
402        </a>
403      </li>
404    
405  
406
407      
408        
409  
410  
411  
412  
413    
414      
415    
416    
417    
418      <li class="md-tabs__item">
419        <a href="../../mcp/" class="md-tabs__link">
420          
421  
422  MCP
423
424        </a>
425      </li>
426    
427  
428
429      
430        
431  
432  
433  
434    
435  
436  
437    
438      
439    
440    
441    
442      <li class="md-tabs__item md-tabs__item--active">
443        <a href="../go_command/" class="md-tabs__link">
444          
445  
446  Reference
447
448        </a>
449      </li>
450    
451  
452
453      
454    </ul>
455  </div>
456</nav>
457          
458        
459      
460      <main class="md-main" data-md-component="main">
461        <div class="md-main__inner md-grid">
462          
463            
464              
465              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
466                <div class="md-sidebar__scrollwrap">
467                  <div class="md-sidebar__inner">
468                    
469
470
471  
472
473
474<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
475  <label class="md-nav__title" for="__drawer">
476    <a href="../.." title="fast-agent documentation" class="md-nav__button md-logo" aria-label="fast-agent documentation" data-md-component="logo">
477      
478  <img src="../../assets/brand/fast-agent-icon.svg" alt="fast-agent documentation">
479
480    </a>
481    fast-agent documentation
482  </label>
483  
484    <div class="md-nav__source">
485      <a href="https://github.com/evalstate/fast-agent" title="Go to repository" class="md-source" data-md-component="source">
486  <div class="md-source__icon md-icon">
487    
488    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.-->
488<path fill="currentColor" d="M216.5 362.5c-66-8-112.5-55.5-112.5-117 0-25 9-52 24-70-6.5-16.5-5.5-51.5 2-66 20-2.5 47 8 63 22.5 19-6 39-9 63.5-9s44.5 3 62.5 8.5c15.5-14 43-24.5 63-22 7 13.5 8 48.5 1.5 65.5 16 19 24.5 44.5 24.5 70.5 0 61.5-46.5 108-113.5 116.5 17 11 28.5 35 28.5 62.5v52c0 15 12.5 23.5 27.5 17.5C441 459.5 512 369 512 257 512 115.5 397 0 255.5 0S0 115.5 0 257c0 111 70.5 203 165.5 237.5 13.5 5 26.5-4 26.5-17.5v-40c-7 3-16 5-24 5-33 0-52.5-18-66.5-51.5-5.5-13.5-11.5-21.5-23-23-6-.5-8-3-8-6 0-6 10-10.5 20-10.5 14.5 0 27 9 40 27.5 10 14.5 20.5 21 33 21s20.5-4.5 32-16c8.5-8.5 15-16 21-21"/></svg>
489  </div>
490  <div class="md-source__repository">
491    evalstate/fast-agent
492  </div>
493</a>
494    </div>
495  
496  <ul class="md-nav__list" data-md-scrollfix>
497    
498      
499      
500  
501  
502  
503  
504    <li class="md-nav__item">
505      <a href="../.." class="md-nav__link">
506        
507  
508  
509  <span class="md-ellipsis">
510    
511  
512  fast-agent
513
514    
515  </span>
516  
517  
518
519      </a>
520    </li>
521  
522
523    
524      
525      
526  
527  
528  
529  
530    
531    
532    
533    
534      
535      
536        
537      
538    
539    
540    <li class="md-nav__item md-nav__item--nested">
541      
542        
543        
544          
545        
546        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
547        
548          
549          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
550            
551  
552  
553  <span class="md-ellipsis">
554    
555  
556  Guides
557
558    
559  </span>
560  
561  
562
563            <span class="md-nav__icon md-icon"></span>
564          </label>
565        
566        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
567          <label class="md-nav__title" for="__nav_2">
568            <span class="md-nav__icon md-icon"></span>
569            
570  
571  Guides
572
573          </label>
574          <ul class="md-nav__list" data-md-scrollfix>
575            
576              
577                
578  
579  
580  
581  
582    <li class="md-nav__item">
583      <a href="../../guides/core-concepts/" class="md-nav__link">
584        
585  
586  
587  <span class="md-ellipsis">
588    
589  
590  Core Concepts
591
592    
593  </span>
594  
595  
596
597      </a>
598    </li>
599  
600
601              
602            
603              
604                
605  
606  
607  
608  
609    <li class="md-nav__item">
610      <a href="../../guides/migrating-to-0-10/" class="md-nav__link">
611        
612  
613  
614  <span class="md-ellipsis">
615    
616  
617  Migrating to 0.10
618
619    
620  </span>
621  
622  
623
624      </a>
625    </li>
626  
627
628              
629            
630              
631                
632  
633  
634  
635  
636    <li class="md-nav__item">
637      <a href="../../guides/subagents/" class="md-nav__link">
638        
639  
640  
641  <span class="md-ellipsis">
642    
643  
644  Subagents
645
646    
647  </span>
648  
649  
650
651      </a>
652    </li>
653  
654
655              
656            
657              
658                
659  
660  
661  
662  
663    <li class="md-nav__item">
664      <a href="../../guides/tui/" class="md-nav__link">
665        
666  
667  
668  <span class="md-ellipsis">
669    
670  
671  Using the TUI
672
673    
674  </span>
675  
676  
677
678      </a>
679    </li>
680  
681
682              
683            
684              
685                
686  
687  
688  
689  
690    <li class="md-nav__item">
691      <a href="../../guides/codex/" class="md-nav__link">
692        
693  
694  
695  <span class="md-ellipsis">
696    
697  
698  Code with OpenAI Codex
699
700    
701  </span>
702  
703  
704
705      </a>
706    </li>
707  
708
709              
710            
711              
712                
713  
714  
715  
716  
717    <li class="md-nav__item">
718      <a href="../../guides/hf-dev/" class="md-nav__link">
719        
720  
721  
722  <span class="md-ellipsis">
723    
724  
725  Code with Hugging Face
726
727    
728  </span>
729  
730  
731
732      </a>
733    </li>
734  
735
736              
737            
738              
739                
740  
741  
742  
743  
744    <li class="md-nav__item">
745      <a href="../../guides/migrate-automations/" class="md-nav__link">
746        
747  
748  
749  <span class="md-ellipsis">
750    
751  
752  Migrate Automations
753
754    
755  </span>
756  
757  
758
759      </a>
760    </li>
761  
762
763              
764            
765              
766                
767  
768  
769  
770  
771    <li class="md-nav__item">
772      <a href="../../guides/skills/" class="md-nav__link">
773        
774  
775  
776  <span class="md-ellipsis">
777    
778  
779  Agent Skills
780
781    
782  </span>
783  
784  
785
786      </a>
787    </li>
788  
789
790              
791            
792              
793                
794  
795  
796  
797  
798    <li class="md-nav__item">
799      <a href="../../guides/batch-processing/" class="md-nav__link">
800        
801  
802  
803  <span class="md-ellipsis">
804    
805  
806  Batch Processing
807
808    
809  </span>
810  
811  
812
813      </a>
814    </li>
815  
816
817              
818            
819              
820                
821  
822  
823  
824  
825    <li class="md-nav__item">
826      <a href="../../guides/gepa/" class="md-nav__link">
827        
828  
829  
830  <span class="md-ellipsis">
831    
832  
833  GEPA Optimization
834
835    
836  </span>
837  
838  
839
840      </a>
841    </li>
842  
843
844              
845            
846              
847                
848  
849  
850  
851  
852    <li class="md-nav__item">
853      <a href="../../guides/structured-outputs/" class="md-nav__link">
854        
855  
856  
857  <span class="md-ellipsis">
858    
859  
860  Structured Outputs
861
862    
863  </span>
864  
865  
866
867      </a>
868    </li>
869  
870
871              
872            
873              
874                
875  
876  
877  
878  
879    <li class="md-nav__item">
880      <a href="../../guides/privacy_filter/" class="md-nav__link">
881        
882  
883  
884  <span class="md-ellipsis">
885    
886  
887  Privacy Filter
888
889    
890  </span>
891  
892  
893
894      </a>
895    </li>
896  
897
898              
899            
900              
901                
902  
903  
904  
905  
906    <li class="md-nav__item">
907      <a href="../../guides/compaction/" class="md-nav__link">
908        
909  
910  
911  <span class="md-ellipsis">
912    
913  
914  Compaction
915
916    
917  </span>
918  
919  
920
921      </a>
922    </li>
923  
924
925              
926            
927              
928                
929  
930  
931  
932  
933    <li class="md-nav__item">
934      <a href="../../guides/responses-caching/" class="md-nav__link">
935        
936  
937  
938  <span class="md-ellipsis">
939    
940  
941  Responses prompt caching
942
943    
944  </span>
945  
946  
947
948      </a>
949    </li>
950  
951
952              
953            
954          </ul>
955        </nav>
956      
957    </li>
958  
959
960    
961      
962      
963  
964  
965  
966  
967    
968    
969    
970    
971      
972      
973        
974      
975    
976    
977    <li class="md-nav__item md-nav__item--nested">
978      
979        
980        
981          
982        
983        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
984        
985          
986          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
987            
988  
989  
990  <span class="md-ellipsis">
991    
992  
993  Agents
994
995    
996  </span>
997  
998  
999
1000            <span class="md-nav__icon md-icon"></span>
1001          </label>
1002        
1003        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
1004          <label class="md-nav__title" for="__nav_3">
1005            <span class="md-nav__icon md-icon"></span>
1006            
1007  
1008  Agents
1009
1010          </label>
1011          <ul class="md-nav__list" data-md-scrollfix>
1012            
1013              
1014                
1015  
1016  
1017  
1018  
1019    
1020    
1021    
1022    
1023      
1024      
1025        
1026      
1027    
1028    
1029    <li class="md-nav__item md-nav__item--nested">
1030      
1031        
1032        
1033          
1034        
1035        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_1" >
1036        
1037          
1038          <label class="md-nav__link" for="__nav_3_1" id="__nav_3_1_label" tabindex="0">
1039            
1040  
1041  
1042  <span class="md-ellipsis">
1043    
1044  
1045  Defining Agents
1046
1047    
1048  </span>
1049  
1050  
1051
1052            <span class="md-nav__icon md-icon"></span>
1053          </label>
1054        
1055        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_1_label" aria-expanded="false">
1056          <label class="md-nav__title" for="__nav_3_1">
1057            <span class="md-nav__icon md-icon"></span>
1058            
1059  
1060  Defining Agents
1061
1062          </label>
1063          <ul class="md-nav__list" data-md-scrollfix>
1064            
1065              
1066                
1067  
1068  
1069  
1070  
1071    <li class="md-nav__item">
1072      <a href="../../agents/defining/" class="md-nav__link">
1073        
1074  
1075  
1076  <span class="md-ellipsis">
1077    
1078  
1079  Overview
1080
1081    
1082  </span>
1083  
1084  
1085
1086      </a>
1087    </li>
1088  
1089
1090              
1091            
1092              
1093                
1094  
1095  
1096  
1097  
1098    <li class="md-nav__item">
1099      <a href="../../agents/defining/harness-api/" class="md-nav__link">
1100        
1101  
1102  
1103  <span class="md-ellipsis">
1104    
1105  
1106  Harness API
1107
1108    
1109  </span>
1110  
1111  
1112
1113      </a>
1114    </li>
1115  
1116
1117              
1118            
1119              
1120                
1121  
1122  
1123  
1124  
1125    <li class="md-nav__item">
1126      <a href="../../agents/defining/python_api/" class="md-nav__link">
1127        
1128  
1129  
1130  <span class="md-ellipsis">
1131    
1132  
1133  Python API
1134
1135    
1136  </span>
1137  
1138  
1139
1140      </a>
1141    </li>
1142  
1143
1144              
1145            
1146              
1147                
1148  
1149  
1150  
1151  
1152    <li class="md-nav__item">
1153      <a href="../../agents/defining/agent_cards/" class="md-nav__link">
1154        
1155  
1156  
1157  <span class="md-ellipsis">
1158    
1159  
1160  Agent Cards
1161
1162    
1163  </span>
1164  
1165  
1166
1167      </a>
1168    </li>
1169  
1170
1171              
1172            
1173          </ul>
1174        </nav>
1175      
1176    </li>
1177  
1178
1179              
1180            
1181              
1182                
1183  
1184  
1185  
1186  
1187    <li class="md-nav__item">
1188      <a href="../../agents/environments/" class="md-nav__link">
1189        
1190  
1191  
1192  <span class="md-ellipsis">
1193    
1194  
1195  Execution Environments
1196
1197    
1198  </span>
1199  
1200  
1201
1202      </a>
1203    </li>
1204  
1205
1206              
1207            
1208              
1209                
1210  
1211  
1212  
1213  
1214    <li class="md-nav__item">
1215      <a href="../../agents/workflows/" class="md-nav__link">
1216        
1217  
1218  
1219  <span class="md-ellipsis">
1220    
1221  
1222  Workflows
1223
1224    
1225  </span>
1226  
1227  
1228
1229      </a>
1230    </li>
1231  
1232
1233              
1234            
1235              
1236                
1237  
1238  
1239  
1240  
1241    <li class="md-nav__item">
1242      <a href="../../agents/running/" class="md-nav__link">
1243        
1244  
1245  
1246  <span class="md-ellipsis">
1247    
1248  
1249  Deploy and Run
1250
1251    
1252  </span>
1253  
1254  
1255
1256      </a>
1257    </li>
1258  
1259
1260              
1261            
1262              
1263                
1264  
1265  
1266  
1267  
1268    <li class="md-nav__item">
1269      <a href="../../agents/prompting/" class="md-nav__link">
1270        
1271  
1272  
1273  <span class="md-ellipsis">
1274    
1275  
1276  Prompting Agents
1277
1278    
1279  </span>
1280  
1281  
1282
1283      </a>
1284    </li>
1285  
1286
1287              
1288            
1289              
1290                
1291  
1292  
1293  
1294  
1295    <li class="md-nav__item">
1296      <a href="../../agents/tool_runner/" class="md-nav__link">
1297        
1298  
1299  
1300  <span class="md-ellipsis">
1301    
1302  
1303  Tool Runner
1304
1305    
1306  </span>
1307  
1308  
1309
1310      </a>
1311    </li>
1312  
1313
1314              
1315            
1316              
1317                
1318  
1319  
1320  
1321  
1322    <li class="md-nav__item">
1323      <a href="../../agents/instructions/" class="md-nav__link">
1324        
1325  
1326  
1327  <span class="md-ellipsis">
1328    
1329  
1330  System Prompts
1331
1332    
1333  </span>
1334  
1335  
1336
1337      </a>
1338    </li>
1339  
1340
1341              
1342            
1343              
1344                
1345  
1346  
1347  
1348  
1349    <li class="md-nav__item">
1350      <a href="../../agents/plugins/" class="md-nav__link">
1351        
1352  
1353  
1354  <span class="md-ellipsis">
1355    
1356  
1357  Command Plugins
1358
1359    
1360  </span>
1361  
1362  
1363
1364      </a>
1365    </li>
1366  
1367
1368              
1369            
1370          </ul>
1371        </nav>
1372      
1373    </li>
1374  
1375
1376    
1377      
1378      
1379  
1380  
1381  
1382  
1383    
1384    
1385    
1386    
1387      
1388      
1389        
1390      
1391    
1392    
1393    <li class="md-nav__item md-nav__item--nested">
1394      
1395        
1396        
1397          
1398        
1399        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
1400        
1401          
1402          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1403            
1404  
1405  
1406  <span class="md-ellipsis">
1407    
1408  
1409  Models
1410
1411    
1412  </span>
1413  
1414  
1415
1416            <span class="md-nav__icon md-icon"></span>
1417          </label>
1418        
1419        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1420          <label class="md-nav__title" for="__nav_4">
1421            <span class="md-nav__icon md-icon"></span>
1422            
1423  
1424  Models
1425
1426          </label>
1427          <ul class="md-nav__list" data-md-scrollfix>
1428            
1429              
1430                
1431  
1432  
1433  
1434  
1435    <li class="md-nav__item">
1436      <a href="../../models/" class="md-nav__link">
1437        
1438  
1439  
1440  <span class="md-ellipsis">
1441    
1442  
1443  Getting Started
1444
1445    
1446  </span>
1447  
1448  
1449
1450      </a>
1451    </li>
1452  
1453
1454              
1455            
1456              
1457                
1458  
1459  
1460  
1461  
1462    
1463    
1464    
1465    
1466      
1467      
1468        
1469      
1470    
1471    
1472    <li class="md-nav__item md-nav__item--nested">
1473      
1474        
1475        
1476          
1477        
1478        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_2" >
1479        
1480          
1481          <label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
1482            
1483  
1484  
1485  <span class="md-ellipsis">
1486    
1487  
1488  Providers
1489
1490    
1491  </span>
1492  
1493  
1494
1495            <span class="md-nav__icon md-icon"></span>
1496          </label>
1497        
1498        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
1499          <label class="md-nav__title" for="__nav_4_2">
1500            <span class="md-nav__icon md-icon"></span>
1501            
1502  
1503  Providers
1504
1505          </label>
1506          <ul class="md-nav__list" data-md-scrollfix>
1507            
1508              
1509                
1510  
1511  
1512  
1513  
1514    <li class="md-nav__item">
1515      <a href="../../models/llm_providers/" class="md-nav__link">
1516        
1517  
1518  
1519  <span class="md-ellipsis">
1520    
1521  
1522  Provider Configuration
1523
1524    
1525  </span>
1526  
1527  
1528
1529      </a>
1530    </li>
1531  
1532
1533              
1534            
1535              
1536                
1537  
1538  
1539  
1540  
1541    <li class="md-nav__item">
1542      <a href="../../models/providers/openai/" class="md-nav__link">
1543        
1544  
1545  
1546  <span class="md-ellipsis">
1547    
1548  
1549  OpenAI
1550
1551    
1552  </span>
1553  
1554  
1555
1556      </a>
1557    </li>
1558  
1559
1560              
1561            
1562              
1563                
1564  
1565  
1566  
1567  
1568    <li class="md-nav__item">
1569      <a href="../../models/providers/anthropic/" class="md-nav__link">
1570        
1571  
1572  
1573  <span class="md-ellipsis">
1574    
1575  
1576  Anthropic
1577
1578    
1579  </span>
1580  
1581  
1582
1583      </a>
1584    </li>
1585  
1586
1587              
1588            
1589              
1590                
1591  
1592  
1593  
1594  
1595    <li class="md-nav__item">
1596      <a href="../../models/providers/copilot/" class="md-nav__link">
1597        
1598  
1599  
1600  <span class="md-ellipsis">
1601    
1602  
1603  GitHub Copilot
1604
1605    
1606  </span>
1607  
1608  
1609
1610      </a>
1611    </li>
1612  
1613
1614              
1615            
1616              
1617                
1618  
1619  
1620  
1621  
1622    <li class="md-nav__item">
1623      <a href="../../models/providers/xai/" class="md-nav__link">
1624        
1625  
1626  
1627  <span class="md-ellipsis">
1628    
1629  
1630  xAI
1631
1632    
1633  </span>
1634  
1635  
1636
1637      </a>
1638    </li>
1639  
1640
1641              
1642            
1643              
1644                
1645  
1646  
1647  
1648  
1649    <li class="md-nav__item">
1650      <a href="../../models/providers/metaai/" class="md-nav__link">
1651        
1652  
1653  
1654  <span class="md-ellipsis">
1655    
1656  
1657  MetaAI
1658
1659    
1660  </span>
1661  
1662  
1663
1664      </a>
1665    </li>
1666  
1667
1668              
1669            
1670              
1671                
1672  
1673  
1674  
1675  
1676    <li class="md-nav__item">
1677      <a href="../../models/providers/deepseek/" class="md-nav__link">
1678        
1679  
1680  
1681  <span class="md-ellipsis">
1682    
1683  
1684  DeepSeek
1685
1686    
1687  </span>
1688  
1689  
1690
1691      </a>
1692    </li>
1693  
1694
1695              
1696            
1697              
1698                
1699  
1700  
1701  
1702  
1703    <li class="md-nav__item">
1704      <a href="../../models/providers/moonshot/" class="md-nav__link">
1705        
1706  
1707  
1708  <span class="md-ellipsis">
1709    
1710  
1711  Moonshot
1712
1713    
1714  </span>
1715  
1716  
1717
1718      </a>
1719    </li>
1720  
1721
1722              
1723            
1724              
1725                
1726  
1727  
1728  
1729  
1730    <li class="md-nav__item">
1731      <a href="../../models/providers/zai/" class="md-nav__link">
1732        
1733  
1734  
1735  <span class="md-ellipsis">
1736    
1737  
1738  Z.ai
1739
1740    
1741  </span>
1742  
1743  
1744
1745      </a>
1746    </li>
1747  
1748
1749              
1750            
1751              
1752                
1753  
1754  
1755  
1756  
1757    <li class="md-nav__item">
1758      <a href="../../models/providers/huggingface/" class="md-nav__link">
1759        
1760  
1761  
1762  <span class="md-ellipsis">
1763    
1764  
1765  Hugging Face
1766
1767    
1768  </span>
1769  
1770  
1771
1772      </a>
1773    </li>
1774  
1775
1776              
1777            
1778              
1779                
1780  
1781  
1782  
1783  
1784    <li class="md-nav__item">
1785      <a href="../../models/providers/google/" class="md-nav__link">
1786        
1787  
1788  
1789  <span class="md-ellipsis">
1790    
1791  
1792  Google
1793
1794    
1795  </span>
1796  
1797  
1798
1799      </a>
1800    </li>
1801  
1802
1803              
1804            
1805              
1806                
1807  
1808  
1809  
1810  
1811    <li class="md-nav__item">
1812      <a href="../../models/providers/llamacpp/" class="md-nav__link">
1813        
1814  
1815  
1816  <span class="md-ellipsis">
1817    
1818  
1819  llama.cpp
1820
1821    
1822  </span>
1823  
1824  
1825
1826      </a>
1827    </li>
1828  
1829
1830              
1831            
1832              
1833                
1834  
1835  
1836  
1837  
1838    <li class="md-nav__item">
1839      <a href="../../models/providers/azure/" class="md-nav__link">
1840        
1841  
1842  
1843  <span class="md-ellipsis">
1844    
1845  
1846  Azure
1847
1848    
1849  </span>
1850  
1851  
1852
1853      </a>
1854    </li>
1855  
1856
1857              
1858            
1859              
1860                
1861  
1862  
1863  
1864  
1865    <li class="md-nav__item">
1866      <a href="../../models/providers/bedrock/" class="md-nav__link">
1867        
1868  
1869  
1870  <span class="md-ellipsis">
1871    
1872  
1873  Bedrock
1874
1875    
1876  </span>
1877  
1878  
1879
1880      </a>
1881    </li>
1882  
1883
1884              
1885            
1886              
1887                
1888  
1889  
1890  
1891  
1892    <li class="md-nav__item">
1893      <a href="../../models/providers/additional/" class="md-nav__link">
1894        
1895  
1896  
1897  <span class="md-ellipsis">
1898    
1899  
1900  Additional Providers
1901
1902    
1903  </span>
1904  
1905  
1906
1907      </a>
1908    </li>
1909  
1910
1911              
1912            
1913          </ul>
1914        </nav>
1915      
1916    </li>
1917  
1918
1919              
1920            
1921              
1922                
1923  
1924  
1925  
1926  
1927    
1928    
1929    
1930    
1931      
1932      
1933        
1934      
1935    
1936    
1937    <li class="md-nav__item md-nav__item--nested">
1938      
1939        
1940        
1941          
1942        
1943        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
1944        
1945          
1946          <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
1947            
1948  
1949  
1950  <span class="md-ellipsis">
1951    
1952  
1953  Reference
1954
1955    
1956  </span>
1957  
1958  
1959
1960            <span class="md-nav__icon md-icon"></span>
1961          </label>
1962        
1963        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
1964          <label class="md-nav__title" for="__nav_4_3">
1965            <span class="md-nav__icon md-icon"></span>
1966            
1967  
1968  Reference
1969
1970          </label>
1971          <ul class="md-nav__list" data-md-scrollfix>
1972            
1973              
1974                
1975  
1976  
1977  
1978  
1979    <li class="md-nav__item">
1980      <a href="../../models/model_overlays/" class="md-nav__link">
1981        
1982  
1983  
1984  <span class="md-ellipsis">
1985    
1986  
1987  Model Overlays
1988
1989    
1990  </span>
1991  
1992  
1993
1994      </a>
1995    </li>
1996  
1997
1998              
1999            
2000              
2001                
2002  
2003  
2004  
2005  
2006    <li class="md-nav__item">
2007      <a href="../../models/models_reference/" class="md-nav__link">
2008        
2009  
2010  
2011  <span class="md-ellipsis">
2012    
2013  
2014  Models Reference
2015
2016    
2017  </span>
2018  
2019  
2020
2021      </a>
2022    </li>
2023  
2024
2025              
2026            
2027              
2028                
2029  
2030  
2031  
2032  
2033    <li class="md-nav__item">
2034      <a href="../../models/internal_models/" class="md-nav__link">
2035        
2036  
2037  
2038  <span class="md-ellipsis">
2039    
2040  
2041  Internal Models
2042
2043    
2044  </span>
2045  
2046  
2047
2048      </a>
2049    </li>
2050  
2051
2052              
2053            
2054          </ul>
2055        </nav>
2056      
2057    </li>
2058  
2059
2060              
2061            
2062          </ul>
2063        </nav>
2064      
2065    </li>
2066  
2067
2068    
2069      
2070      
2071  
2072  
2073  
2074  
2075    
2076    
2077    
2078    
2079      
2080      
2081        
2082      
2083    
2084    
2085    <li class="md-nav__item md-nav__item--nested">
2086      
2087        
2088        
2089          
2090        
2091        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
2092        
2093          
2094          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
2095            
2096  
2097  
2098  <span class="md-ellipsis">
2099    
2100  
2101  ACP
2102
2103    
2104  </span>
2105  
2106  
2107
2108            <span class="md-nav__icon md-icon"></span>
2109          </label>
2110        
2111        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
2112          <label class="md-nav__title" for="__nav_5">
2113            <span class="md-nav__icon md-icon"></span>
2114            
2115  
2116  ACP
2117
2118          </label>
2119          <ul class="md-nav__list" data-md-scrollfix>
2120            
2121              
2122                
2123  
2124  
2125  
2126  
2127    
2128    
2129    
2130    
2131      
2132      
2133        
2134      
2135    
2136    
2137    <li class="md-nav__item md-nav__item--nested">
2138      
2139        
2140        
2141          
2142        
2143        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_1" >
2144        
2145          
2146          <label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
2147            
2148  
2149  
2150  <span class="md-ellipsis">
2151    
2152  
2153  Agent Client Protocol
2154
2155    
2156  </span>
2157  
2158  
2159
2160            <span class="md-nav__icon md-icon"></span>
2161          </label>
2162        
2163        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
2164          <label class="md-nav__title" for="__nav_5_1">
2165            <span class="md-nav__icon md-icon"></span>
2166            
2167  
2168  Agent Client Protocol
2169
2170          </label>
2171          <ul class="md-nav__list" data-md-scrollfix>
2172            
2173              
2174                
2175  
2176  
2177  
2178  
2179    <li class="md-nav__item">
2180      <a href="../../acp/" class="md-nav__link">
2181        
2182  
2183  
2184  <span class="md-ellipsis">
2185    
2186  
2187  Using as an Agent
2188
2189    
2190  </span>
2191  
2192  
2193
2194      </a>
2195    </li>
2196  
2197
2198              
2199            
2200              
2201                
2202  
2203  
2204  
2205  
2206    <li class="md-nav__item">
2207      <a href="../../acp/customizing_agents/" class="md-nav__link">
2208        
2209  
2210  
2211  <span class="md-ellipsis">
2212    
2213  
2214  Customizing Agents
2215
2216    
2217  </span>
2218  
2219  
2220
2221      </a>
2222    </li>
2223  
2224
2225              
2226            
2227          </ul>
2228        </nav>
2229      
2230    </li>
2231  
2232
2233              
2234            
2235          </ul>
2236        </nav>
2237      
2238    </li>
2239  
2240
2241    
2242      
2243      
2244  
2245  
2246  
2247  
2248    
2249    
2250    
2251    
2252      
2253      
2254        
2255      
2256    
2257    
2258    <li class="md-nav__item md-nav__item--nested">
2259      
2260        
2261        
2262          
2263        
2264        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
2265        
2266          
2267          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
2268            
2269  
2270  
2271  <span class="md-ellipsis">
2272    
2273  
2274  A2A
2275
2276    
2277  </span>
2278  
2279  
2280
2281            <span class="md-nav__icon md-icon"></span>
2282          </label>
2283        
2284        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2285          <label class="md-nav__title" for="__nav_6">
2286            <span class="md-nav__icon md-icon"></span>
2287            
2288  
2289  A2A
2290
2291          </label>
2292          <ul class="md-nav__list" data-md-scrollfix>
2293            
2294              
2295                
2296  
2297  
2298  
2299  
2300    <li class="md-nav__item">
2301      <a href="../../a2a/getting-started/" class="md-nav__link">
2302        
2303  
2304  
2305  <span class="md-ellipsis">
2306    
2307  
2308  Getting Started
2309
2310    
2311  </span>
2312  
2313  
2314
2315      </a>
2316    </li>
2317  
2318
2319              
2320            
2321              
2322                
2323  
2324  
2325  
2326  
2327    <li class="md-nav__item">
2328      <a href="../../a2a/client/" class="md-nav__link">
2329        
2330  
2331  
2332  <span class="md-ellipsis">
2333    
2334  
2335  Use as Client
2336
2337    
2338  </span>
2339  
2340  
2341
2342      </a>
2343    </li>
2344  
2345
2346              
2347            
2348              
2349                
2350  
2351  
2352  
2353  
2354    <li class="md-nav__item">
2355      <a href="../../a2a/server/" class="md-nav__link">
2356        
2357  
2358  
2359  <span class="md-ellipsis">
2360    
2361  
2362  Serve as A2A Server
2363
2364    
2365  </span>
2366  
2367  
2368
2369      </a>
2370    </li>
2371  
2372
2373              
2374            
2375              
2376                
2377  
2378  
2379  
2380  
2381    <li class="md-nav__item">
2382      <a href="../../a2a/host-on-hf/" class="md-nav__link">
2383        
2384  
2385  
2386  <span class="md-ellipsis">
2387    
2388  
2389  Host on HF
2390
2391    
2392  </span>
2393  
2394  
2395
2396      </a>
2397    </li>
2398  
2399
2400              
2401            
2402              
2403                
2404  
2405  
2406  
2407  
2408    <li class="md-nav__item">
2409      <a href="../../a2a/api/" class="md-nav__link">
2410        
2411  
2412  
2413  <span class="md-ellipsis">
2414    
2415  
2416  API Usage
2417
2418    
2419  </span>
2420  
2421  
2422
2423      </a>
2424    </li>
2425  
2426
2427              
2428            
2429              
2430                
2431  
2432  
2433  
2434  
2435    <li class="md-nav__item">
2436      <a href="../../a2a/protocol-compliance/" class="md-nav__link">
2437        
2438  
2439  
2440  <span class="md-ellipsis">
2441    
2442  
2443  Protocol Compliance
2444
2445    
2446  </span>
2447  
2448  
2449
2450      </a>
2451    </li>
2452  
2453
2454              
2455            
2456          </ul>
2457        </nav>
2458      
2459    </li>
2460  
2461
2462    
2463      
2464      
2465  
2466  
2467  
2468  
2469    
2470    
2471    
2472    
2473      
2474      
2475        
2476      
2477    
2478    
2479    <li class="md-nav__item md-nav__item--nested">
2480      
2481        
2482        
2483          
2484        
2485        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
2486        
2487          
2488          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2489            
2490  
2491  
2492  <span class="md-ellipsis">
2493    
2494  
2495  MCP
2496
2497    
2498  </span>
2499  
2500  
2501
2502            <span class="md-nav__icon md-icon"></span>
2503          </label>
2504        
2505        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2506          <label class="md-nav__title" for="__nav_7">
2507            <span class="md-nav__icon md-icon"></span>
2508            
2509  
2510  MCP
2511
2512          </label>
2513          <ul class="md-nav__list" data-md-scrollfix>
2514            
2515              
2516                
2517  
2518  
2519  
2520  
2521    <li class="md-nav__item">
2522      <a href="../../mcp/" class="md-nav__link">
2523        
2524  
2525  
2526  <span class="md-ellipsis">
2527    
2528  
2529  Overview
2530
2531    
2532  </span>
2533  
2534  
2535
2536      </a>
2537    </li>
2538  
2539
2540              
2541            
2542              
2543                
2544  
2545  
2546  
2547  
2548    <li class="md-nav__item">
2549      <a href="../../mcp/migration/" class="md-nav__link">
2550        
2551  
2552  
2553  <span class="md-ellipsis">
2554    
2555  
2556  Migrate MCP Configuration
2557
2558    
2559  </span>
2560  
2561  
2562
2563      </a>
2564    </li>
2565  
2566
2567              
2568            
2569              
2570                
2571  
2572  
2573  
2574  
2575    
2576    
2577    
2578    
2579      
2580      
2581        
2582      
2583    
2584    
2585    <li class="md-nav__item md-nav__item--nested">
2586      
2587        
2588        
2589          
2590        
2591        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7_3" >
2592        
2593          
2594          <label class="md-nav__link" for="__nav_7_3" id="__nav_7_3_label" tabindex="0">
2595            
2596  
2597  
2598  <span class="md-ellipsis">
2599    
2600  
2601  Client
2602
2603    
2604  </span>
2605  
2606  
2607
2608            <span class="md-nav__icon md-icon"></span>
2609          </label>
2610        
2611        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_3_label" aria-expanded="false">
2612          <label class="md-nav__title" for="__nav_7_3">
2613            <span class="md-nav__icon md-icon"></span>
2614            
2615  
2616  Client
2617
2618          </label>
2619          <ul class="md-nav__list" data-md-scrollfix>
2620            
2621              
2622                
2623  
2624  
2625  
2626  
2627    <li class="md-nav__item">
2628      <a href="../../mcp/client-servers/" class="md-nav__link">
2629        
2630  
2631  
2632  <span class="md-ellipsis">
2633    
2634  
2635  Connect to Servers
2636
2637    
2638  </span>
2639  
2640  
2641
2642      </a>
2643    </li>
2644  
2645
2646              
2647            
2648              
2649                
2650  
2651  
2652  
2653  
2654    <li class="md-nav__item">
2655      <a href="../../mcp/mcp-oauth/" class="md-nav__link">
2656        
2657  
2658  
2659  <span class="md-ellipsis">
2660    
2661  
2662  Connect with OAuth
2663
2664    
2665  </span>
2666  
2667  
2668
2669      </a>
2670    </li>
2671  
2672
2673              
2674            
2675              
2676                
2677  
2678  
2679  
2680  
2681    <li class="md-nav__item">
2682      <a href="../../mcp/mcp-inspect-transport/" class="md-nav__link">
2683        
2684  
2685  
2686  <span class="md-ellipsis">
2687    
2688  
2689  Inspect MCP Transports
2690
2691    
2692  </span>
2693  
2694  
2695
2696      </a>
2697    </li>
2698  
2699
2700              
2701            
2702          </ul>
2703        </nav>
2704      
2705    </li>
2706  
2707
2708              
2709            
2710              
2711                
2712  
2713  
2714  
2715  
2716    
2717    
2718    
2719    
2720      
2721      
2722        
2723      
2724    
2725    
2726    <li class="md-nav__item md-nav__item--nested">
2727      
2728        
2729        
2730          
2731        
2732        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7_4" >
2733        
2734          
2735          <label class="md-nav__link" for="__nav_7_4" id="__nav_7_4_label" tabindex="0">
2736            
2737  
2738  
2739  <span class="md-ellipsis">
2740    
2741  
2742  Apps
2743
2744    
2745  </span>
2746  
2747  
2748
2749            <span class="md-nav__icon md-icon"></span>
2750          </label>
2751        
2752        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_4_label" aria-expanded="false">
2753          <label class="md-nav__title" for="__nav_7_4">
2754            <span class="md-nav__icon md-icon"></span>
2755            
2756  
2757  Apps
2758
2759          </label>
2760          <ul class="md-nav__list" data-md-scrollfix>
2761            
2762              
2763                
2764  
2765  
2766  
2767  
2768    <li class="md-nav__item">
2769      <a href="../../mcp/mcp-apps/" class="md-nav__link">
2770        
2771  
2772  
2773  <span class="md-ellipsis">
2774    
2775  
2776  MCP Apps
2777
2778    
2779  </span>
2780  
2781  
2782
2783      </a>
2784    </li>
2785  
2786
2787              
2788            
2789              
2790                
2791  
2792  
2793  
2794  
2795    <li class="md-nav__item">
2796      <a href="../../mcp/openai-apps-sdk/" class="md-nav__link">
2797        
2798  
2799  
2800  <span class="md-ellipsis">
2801    
2802  
2803  OpenAI Apps SDK
2804
2805    
2806  </span>
2807  
2808  
2809
2810      </a>
2811    </li>
2812  
2813
2814              
2815            
2816              
2817                
2818  
2819  
2820  
2821  
2822    <li class="md-nav__item">
2823      <a href="../../mcp/fastmcp-apps/" class="md-nav__link">
2824        
2825  
2826  
2827  <span class="md-ellipsis">
2828    
2829  
2830  FastMCP Apps Adapter
2831
2832    
2833  </span>
2834  
2835  
2836
2837      </a>
2838    </li>
2839  
2840
2841              
2842            
2843          </ul>
2844        </nav>
2845      
2846    </li>
2847  
2848
2849              
2850            
2851              
2852                
2853  
2854  
2855  
2856  
2857    
2858    
2859    
2860    
2861      
2862      
2863        
2864      
2865    
2866    
2867    <li class="md-nav__item md-nav__item--nested">
2868      
2869        
2870        
2871          
2872        
2873        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7_5" >
2874        
2875          
2876          <label class="md-nav__link" for="__nav_7_5" id="__nav_7_5_label" tabindex="0">
2877            
2878  
2879  
2880  <span class="md-ellipsis">
2881    
2882  
2883  Server
2884
2885    
2886  </span>
2887  
2888  
2889
2890            <span class="md-nav__icon md-icon"></span>
2891          </label>
2892        
2893        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_5_label" aria-expanded="false">
2894          <label class="md-nav__title" for="__nav_7_5">
2895            <span class="md-nav__icon md-icon"></span>
2896            
2897  
2898  Server
2899
2900          </label>
2901          <ul class="md-nav__list" data-md-scrollfix>
2902            
2903              
2904                
2905  
2906  
2907  
2908  
2909    <li class="md-nav__item">
2910      <a href="../../mcp/mcp-server/" class="md-nav__link">
2911        
2912  
2913  
2914  <span class="md-ellipsis">
2915    
2916  
2917  Run an MCP Server
2918
2919    
2920  </span>
2921  
2922  
2923
2924      </a>
2925    </li>
2926  
2927
2928              
2929            
2930              
2931                
2932  
2933  
2934  
2935  
2936    <li class="md-nav__item">
2937      <a href="../../mcp/harness-adapter/" class="md-nav__link">
2938        
2939  
2940  
2941  <span class="md-ellipsis">
2942    
2943  
2944  Custom MCP Servers
2945
2946    
2947  </span>
2948  
2949  
2950
2951      </a>
2952    </li>
2953  
2954
2955              
2956            
2957              
2958                
2959  
2960  
2961  
2962  
2963    <li class="md-nav__item">
2964      <a href="../../mcp/huggingface-spaces/" class="md-nav__link">
2965        
2966  
2967  
2968  <span class="md-ellipsis">
2969    
2970  
2971  Host on Hugging Face Spaces
2972
2973    
2974  </span>
2975  
2976  
2977
2978      </a>
2979    </li>
2980  
2981
2982              
2983            
2984          </ul>
2985        </nav>
2986      
2987    </li>
2988  
2989
2990              
2991            
2992              
2993                
2994  
2995  
2996  
2997  
2998    
2999    
3000    
3001    
3002      
3003      
3004        
3005      
3006    
3007    
3008    <li class="md-nav__item md-nav__item--nested">
3009      
3010        
3011        
3012          
3013        
3014        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7_6" >
3015        
3016          
3017          <label class="md-nav__link" for="__nav_7_6" id="__nav_7_6_label" tabindex="0">
3018            
3019  
3020  
3021  <span class="md-ellipsis">
3022    
3023  
3024  Features
3025
3026    
3027  </span>
3028  
3029  
3030
3031            <span class="md-nav__icon md-icon"></span>
3032          </label>
3033        
3034        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_6_label" aria-expanded="false">
3035          <label class="md-nav__title" for="__nav_7_6">
3036            <span class="md-nav__icon md-icon"></span>
3037            
3038  
3039  Features
3040
3041          </label>
3042          <ul class="md-nav__list" data-md-scrollfix>
3043            
3044              
3045                
3046  
3047  
3048  
3049  
3050    <li class="md-nav__item">
3051      <a href="../../mcp/skills-over-mcp/" class="md-nav__link">
3052        
3053  
3054  
3055  <span class="md-ellipsis">
3056    
3057  
3058  Skills over MCP
3059
3060    
3061  </span>
3062  
3063  
3064
3065      </a>
3066    </li>
3067  
3068
3069              
3070            
3071              
3072                
3073  
3074  
3075  
3076  
3077    <li class="md-nav__item">
3078      <a href="../../mcp/elicitations/" class="md-nav__link">
3079        
3080  
3081  
3082  <span class="md-ellipsis">
3083    
3084  
3085  Elicitations
3086
3087    
3088  </span>
3089  
3090  
3091
3092      </a>
3093    </li>
3094  
3095
3096              
3097            
3098              
3099                
3100  
3101  
3102  
3103  
3104    <li class="md-nav__item">
3105      <a href="../../mcp/resources/" class="md-nav__link">
3106        
3107  
3108  
3109  <span class="md-ellipsis">
3110    
3111  
3112  Resources
3113
3114    
3115  </span>
3116  
3117  
3118
3119      </a>
3120    </li>
3121  
3122
3123              
3124            
3125          </ul>
3126        </nav>
3127      
3128    </li>
3129  
3130
3131              
3132            
3133          </ul>
3134        </nav>
3135      
3136    </li>
3137  
3138
3139    
3140      
3141      
3142  
3143  
3144    
3145  
3146  
3147  
3148    
3149    
3150    
3151    
3152      
3153        
3154        
3155      
3156      
3157        
3158      
3159    
3160    
3161    <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
3162      
3163        
3164        
3165        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
3166        
3167          
3168          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
3169            
3170  
3171  
3172  <span class="md-ellipsis">
3173    
3174  
3175  Reference
3176
3177    
3178  </span>
3179  
3180  
3181
3182            <span class="md-nav__icon md-icon"></span>
3183          </label>
3184        
3185        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
3186          <label class="md-nav__title" for="__nav_8">
3187            <span class="md-nav__icon md-icon"></span>
3188            
3189  
3190  Reference
3191
3192          </label>
3193          <ul class="md-nav__list" data-md-scrollfix>
3194            
3195              
3196                
3197  
3198  
3199  
3200  
3201    <li class="md-nav__item">
3202      <a href="../go_command/" class="md-nav__link">
3203        
3204  
3205  
3206  <span class="md-ellipsis">
3207    
3208  
3209  fast-agent go
3210
3211    
3212  </span>
3213  
3214  
3215
3216      </a>
3217    </li>
3218  
3219
3220              
3221            
3222              
3223                
3224  
3225  
3226  
3227  
3228    <li class="md-nav__item">
3229      <a href="../export_command/" class="md-nav__link">
3230        
3231  
3232  
3233  <span class="md-ellipsis">
3234    
3235  
3236  Export Command
3237
3238    
3239  </span>
3240  
3241  
3242
3243      </a>
3244    </li>
3245  
3246
3247              
3248            
3249              
3250                
3251  
3252  
3253  
3254  
3255    <li class="md-nav__item">
3256      <a href="../batch/" class="md-nav__link">
3257        
3258  
3259  
3260  <span class="md-ellipsis">
3261    
3262  
3263  Batch Processing
3264
3265    
3266  </span>
3267  
3268  
3269
3270      </a>
3271    </li>
3272  
3273
3274              
3275            
3276              
3277                
3278  
3279  
3280  
3281  
3282    <li class="md-nav__item">
3283      <a href="../config_file/" class="md-nav__link">
3284        
3285  
3286  
3287  <span class="md-ellipsis">
3288    
3289  
3290  Config File
3291
3292    
3293  </span>
3294  
3295  
3296
3297      </a>
3298    </li>
3299  
3300
3301              
3302            
3303              
3304                
3305  
3306  
3307  
3308  
3309    <li class="md-nav__item">
3310      <a href="../shell_runtime_budgeting/" class="md-nav__link">
3311        
3312  
3313  
3314  <span class="md-ellipsis">
3315    
3316  
3317  Shell Runtime Budgeting
3318
3319    
3320  </span>
3321  
3322  
3323
3324      </a>
3325    </li>
3326  
3327
3328              
3329            
3330              
3331                
3332  
3333  
3334  
3335  
3336    <li class="md-nav__item">
3337      <a href="../reasoning_replay_canonicalization/" class="md-nav__link">
3338        
3339  
3340  
3341  <span class="md-ellipsis">
3342    
3343  
3344  Reasoning Replay Canonicalization
3345
3346    
3347  </span>
3348  
3349  
3350
3351      </a>
3352    </li>
3353  
3354
3355              
3356            
3357              
3358                
3359  
3360  
3361  
3362  
3363    <li class="md-nav__item">
3364      <a href="../cmd_switches/" class="md-nav__link">
3365        
3366  
3367  
3368  <span class="md-ellipsis">
3369    
3370  
3371  Command Line
3372
3373    
3374  </span>
3375  
3376  
3377
3378      </a>
3379    </li>
3380  
3381
3382              
3383            
3384              
3385                
3386  
3387  
3388  
3389  
3390    <li class="md-nav__item">
3391      <a href="../class_reference/" class="md-nav__link">
3392        
3393  
3394  
3395  <span class="md-ellipsis">
3396    
3397  
3398  Class Reference
3399
3400    
3401  </span>
3402  
3403  
3404
3405      </a>
3406    </li>
3407  
3408
3409              
3410            
3411              
3412                
3413  
3414  
3415  
3416  
3417    <li class="md-nav__item">
3418      <a href="../extension_reference/" class="md-nav__link">
3419        
3420  
3421  
3422  <span class="md-ellipsis">
3423    
3424  
3425  Extension Reference
3426
3427    
3428  </span>
3429  
3430  
3431
3432      </a>
3433    </li>
3434  
3435
3436              
3437            
3438              
3439                
3440  
3441  
3442  
3443  
3444    <li class="md-nav__item">
3445      <a href="../open_telemetry/" class="md-nav__link">
3446        
3447  
3448  
3449  <span class="md-ellipsis">
3450    
3451  
3452  Open Telemetry
3453
3454    
3455  </span>
3456  
3457  
3458
3459      </a>
3460    </li>
3461  
3462
3463              
3464            
3465              
3466                
3467  
3468  
3469  
3470  
3471    <li class="md-nav__item">
3472      <a href="../fast_agent_ai_articles/" class="md-nav__link">
3473        
3474  
3475  
3476  <span class="md-ellipsis">
3477    
3478  
3479  Articles & Blog Posts
3480
3481    
3482  </span>
3483  
3484  
3485
3486      </a>
3487    </li>
3488  
3489
3490              
3491            
3492              
3493                
3494  
3495  
3496    
3497  
3498  
3499  
3500    <li class="md-nav__item md-nav__item--active">
3501      
3502      
3503      
3504      
3505        
3506      
3507      
3508        <label class="md-nav__link md-nav__link--active" for="__toc">
3509          
3510  
3511  
3512  <span class="md-ellipsis">
3513    
3514  
3515  Generated Docs
3516
3517    
3518  </span>
3519  
3520  
3521
3522          <span class="md-nav__icon md-icon"></span>
3523        </label>
3524      
3525      <a href="././" class="md-nav__link md-nav__link--active">
3526        
3527  
3528  
3529  <span class="md-ellipsis">
3530    
3531  
3532  Generated Docs
3533
3534    
3535  </span>
3536  
3537  
3538
3539      </a>
3540      
3541        
3542
3543
3544<nav class="md-nav md-nav--secondary" aria-label="On this page">
3545  
3546  
3547  
3548    
3549  
3550  
3551    <label class="md-nav__title" for="__toc">
3552      <span class="md-nav__icon md-icon"></span>
3553      On this page
3554    </label>
3555    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3556      
3557        <li class="md-nav__item">
3558  <a href="#regenerate" class="md-nav__link">
3559    <span class="md-ellipsis">
3560      <span class="md-typeset">
3561        Regenerate
3562      </span>
3563    </span>
3564  </a>
3565  
3566</li>
3567      
3568        <li class="md-nav__item">
3569  <a href="#source-backed-config-values" class="md-nav__link">
3570    <span class="md-ellipsis">
3571      <span class="md-typeset">
3572        Source-Backed Config Values
3573      </span>
3574    </span>
3575  </a>
3576  
3577</li>
3578      
3579    </ul>
3580  
3581</nav>
3582      
3583    </li>
3584  
3585
3586              
3587            
3588              
3589                
3590  
3591  
3592  
3593  
3594    <li class="md-nav__item">
3595      <a href="../docs_automation/" class="md-nav__link">
3596        
3597  
3598  
3599  <span class="md-ellipsis">
3600    
3601  
3602  Docs Automation
3603
3604    
3605  </span>
3606  
3607  
3608
3609      </a>
3610    </li>
3611  
3612
3613              
3614            
3615              
3616                
3617  
3618  
3619  
3620  
3621    <li class="md-nav__item">
3622      <a href="../azure-config/" class="md-nav__link">
3623        
3624  
3625  
3626  <span class="md-ellipsis">
3627    
3628  
3629  Azure Configuration
3630
3631    
3632  </span>
3633  
3634  
3635
3636      </a>
3637    </li>
3638  
3639
3640              
3641            
3642              
3643                
3644  
3645  
3646  
3647  
3648    <li class="md-nav__item">
3649      <a href="../about/" class="md-nav__link">
3650        
3651  
3652  
3653  <span class="md-ellipsis">
3654    
3655  
3656  About
3657
3658    
3659  </span>
3660  
3661  
3662
3663      </a>
3664    </li>
3665  
3666
3667              
3668            
3669          </ul>
3670        </nav>
3671      
3672    </li>
3673  
3674
3675    
3676  </ul>
3677</nav>
3678                  </div>
3679                </div>
3680              </div>
3681            
3682            
3683              
3684              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
3685                <div class="md-sidebar__scrollwrap">
3686                  
3687                    
3688                    
3689                    
3690                      
3691                    
3692                    
3693                      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
3694                      <div class="md-sidebar-button__wrapper">
3695                        <label class="md-sidebar-button" for="__toc"></label>
3696                      </div>
3697                    
3698                  
3699                  <div class="md-sidebar__inner">
3700                    
3701
3702
3703<nav class="md-nav md-nav--secondary" aria-label="On this page">
3704  
3705  
3706  
3707    
3708  
3709  
3710    <label class="md-nav__title" for="__toc">
3711      <span class="md-nav__icon md-icon"></span>
3712      On this page
3713    </label>
3714    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3715      
3716        <li class="md-nav__item">
3717  <a href="#regenerate" class="md-nav__link">
3718    <span class="md-ellipsis">
3719      <span class="md-typeset">
3720        Regenerate
3721      </span>
3722    </span>
3723  </a>
3724  
3725</li>
3726      
3727        <li class="md-nav__item">
3728  <a href="#source-backed-config-values" class="md-nav__link">
3729    <span class="md-ellipsis">
3730      <span class="md-typeset">
3731        Source-Backed Config Values
3732      </span>
3733    </span>
3734  </a>
3735  
3736</li>
3737      
3738    </ul>
3739  
3740</nav>
3741                  </div>
3742                </div>
3743              </div>
3744            
3745          
3746          
3747            <div class="md-content" data-md-component="content">
3748              
3749                
3750
3751
3752
3753  
3754
3755
3756  <nav class="md-path" aria-label="Navigation" >
3757    <ol class="md-path__list">
3758      
3759        
3760  
3761  
3762    <li class="md-path__item">
3763      <a href="../.." class="md-path__link">
3764        
3765  
3766  <span class="md-ellipsis">
3767    fast-agent
3768  </span>
3769
3770      </a>
3771    </li>
3772  
3773
3774      
3775      
3776        
3777  
3778  
3779    
3780    
3781    
3782    
3783    
3784      <li class="md-path__item">
3785        <a href="../go_command/" class="md-path__link">
3786          
3787  
3788  <span class="md-ellipsis">
3789    Reference
3790  </span>
3791
3792        </a>
3793      </li>
3794    
3795  
3796
3797      
3798    </ol>
3799  </nav>
3800
3801              
3802              <article class="md-content__inner md-typeset">
3803                
3804                  
3805  
3806    <a href="https://github.com/evalstate/fast-agent/edit/main/docs/docs/ref/generated_docs.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
3807      
3808      <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-file-pen" viewBox="0 0 24 24">
3808<path d="M12.659 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v9.34"/><path d="M14 2v5a1 1 0 0 0 1 1h5M10.378 12.622a1 1 0 0 1 3 3.003L8.36 20.637a2 2 0 0 1-.854.506l-2.867.837a.5.5 0 0 1-.62-.62l.836-2.869a2 2 0 0 1 .506-.853z"/></svg>
3809    </a>
3810  
3811  
3812    
3813      
3814    
3815    <a href="https://github.com/evalstate/fast-agent/raw/main/docs/docs/ref/generated_docs.md" title="View source of this page" class="md-content__button md-icon">
3816      
3817      <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-file-code-2" viewBox="0 0 24 24"><path d="M4 12.15V4a2 2 0 0 1 2-2h8a2.4 2.4 0 0 1 1.706.706l3.588 3.588A2.4 2.4 0 0 1 20 8v12a2 2 0 0 1-2 2h-3.35"/><path d="M14 2v5a1 1 0 0 0 1 1h5M5 16l-3 3 3 3M9 22l3-3-3-3"/></svg>
3818    </a>
3819  
3820
3821
3822<h1 id="generated-docs">Generated Docs</h1>
3823<p>Some parts of the documentation are generated from the <code>fast-agent</code> Python package to prevent drift, including model alias tables, the models reference page, workflow/request/TUI references, configuration snippets, and the plugin API reference.</p>
3824<h2 id="regenerate">Regenerate</h2>
3825<p>From the <code>fast-agent</code> repo root:</p>
3826<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>uv<span class="w"> </span>run<span class="w"> </span>scripts/docs.py<span class="w"> </span>generate
3827</span></code></pre></div>
3828<p>The generator assumes the normal in-repo <code>docs/</code> layout. If you need to run it from an unusual
3829checkout, point generation at the local <code>fast-agent</code> source:</p>
3830<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nv">FAST_AGENT_REPO_PATH</span><span class="o">=</span>../fast-agent<span class="w"> </span>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>docs/generate_reference_docs.py
3831</span></code></pre></div>
3832<p>Generated files are written to <code>docs/_generated/</code> and included in pages via <code>pymdownx.snippets</code>.</p>
3833<h2 id="source-backed-config-values">Source-Backed Config Values</h2>
3834<p>When documentation needs to show defaults from <code>fast-agent.yaml</code>, prefer generated snippets from
3835the Pydantic settings models over hand-written literals. For example, the compaction YAML snippet
3836and settings table are generated from <code>fast_agent.config.CompactionSettings</code>, then included in both
3837the configuration reference and the compaction guide. If a code default changes, run
3838<code>uv run scripts/docs.py generate</code> and review the generated diff rather than editing each page by
3839hand.</p>
3840<p>Keep the annotated setup template in <code>examples/setup/fast-agent.yaml</code>; packaged setup resources are
3841copied from there during build. When setup defaults mirror code-owned settings, add focused tests so
3842the sample config and generated docs fail visibly if the code default changes.</p>
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852  
3853  
3854
3855
3856
3857
3858
3859
3860                
3861              </article>
3862            </div>
3863          
3864          
3865  
3865<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
3865
3866
3867<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
3867
3868        </div>
3869        
3870          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
3871  
3872  <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-circle-arrow-up" viewBox="0 0 24 24"><circle cx="12" cy="12" r="10"/><path d="m16 12-4-4-4 4M12 16V8"/></svg>
3873  Back to top
3874</button>
3875        
3876      </main>
3877      
3878        <footer class="md-footer">
3879  
3880    
3881      
3882      <nav class="md-footer__inner md-grid" aria-label="Footer" >
3883        
3884          
3885          <a href="../fast_agent_ai_articles/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Articles &amp; Blog Posts">
3886            <div class="md-footer__button md-icon">
3887              
3888              <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-arrow-left" viewBox="0 0 24 24"><path d="m12 19-7-7 7-7M19 12H5"/></svg>
3889            </div>
3890            <div class="md-footer__title">
3891              <span class="md-footer__direction">
3892                Previous
3893              </span>
3894              <div class="md-ellipsis">
3895                Articles & Blog Posts
3896              </div>
3897            </div>
3898          </a>
3899        
3900        
3901          
3902          <a href="../docs_automation/" class="md-footer__link md-footer__link--next" aria-label="Next: Docs Automation">
3903            <div class="md-footer__title">
3904              <span class="md-footer__direction">
3905                Next
3906              </span>
3907              <div class="md-ellipsis">
3908                Docs Automation
3909              </div>
3910            </div>
3911            <div class="md-footer__button md-icon">
3912              
3913              <svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-arrow-right" viewBox="0 0 24 24"><path d="M5 12h14M12 5l7 7-7 7"/></svg>
3914            </div>
3915          </a>
3916        
3917      </nav>
3918    
3919  
3920  <div class="md-footer-meta md-typeset">
3921    <div class="md-footer-meta__inner md-grid">
3922      <div class="md-copyright">
3923  
3924    <div class="md-copyright__highlight">
3925      © 2025-2026 llmindset.co.uk
3926    </div>
3927  
3928  
3929    Made with
3930    <a href="https://zensical.org/" target="_blank" rel="noopener">
3931      Zensical
3932    </a>
3933  
3934</div>
3935      
3936        
3937<div class="md-social">
3938  
3939    
3940    
3941    
3942    
3943      
3944      
3945    
3946    <a href="https://discord.gg/xg5cJ7ndN6" target="_blank" rel="noopener" title="discord.gg" class="md-social__link">
3947      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.--><path fill="currentColor" d="M492.5 69.8c-.2-.3-.4-.6-.8-.7-38.1-17.5-78.4-30-119.7-37.1-.4-.1-.8 0-1.1.1s-.6.4-.8.8c-5.5 9.9-10.5 20.2-14.9 30.6-44.6-6.8-89.9-6.8-134.4 0-4.5-10.5-9.5-20.7-15.1-30.6-.2-.3-.5-.6-.8-.8s-.7-.2-1.1-.2C162.5 39 122.2 51.5 84.1 69c-.3.1-.6.4-.8.7C7.1 183.5-13.8 294.6-3.6 404.2c0 .3.1.5.2.8s.3.4.5.6c44.4 32.9 94 58 146.8 74.2.4.1.8.1 1.1 0s.7-.4.9-.7c11.3-15.4 21.4-31.8 30-48.8.1-.2.2-.5.2-.8s0-.5-.1-.8-.2-.5-.4-.6-.4-.3-.7-.4c-15.8-6.1-31.2-13.4-45.9-21.9-.3-.2-.5-.4-.7-.6s-.3-.6-.3-.9 0-.6.2-.9.3-.5.6-.7c3.1-2.3 6.2-4.7 9.1-7.1.3-.2.6-.4.9-.4s.7 0 1 .1c96.2 43.9 200.4 43.9 295.5 0 .3-.1.7-.2 1-.2s.7.2.9.4c2.9 2.4 6 4.9 9.1 7.2.2.2.4.4.6.7s.2.6.2.9-.1.6-.3.9-.4.5-.6.6c-14.7 8.6-30 15.9-45.9 21.8-.2.1-.5.2-.7.4s-.3.4-.4.7-.1.5-.1.8.1.5.2.8c8.8 17 18.8 33.3 30 48.8.2.3.6.6.9.7s.8.1 1.1 0c52.9-16.2 102.6-41.3 147.1-74.2.2-.2.4-.4.5-.6s.2-.5.2-.8c12.3-126.8-20.5-236.9-86.9-334.5zm-302 267.7c-29 0-52.8-26.6-52.8-59.2s23.4-59.2 52.8-59.2c29.7 0 53.3 26.8 52.8 59.2 0 32.7-23.4 59.2-52.8 59.2m195.4 0c-29 0-52.8-26.6-52.8-59.2s23.4-59.2 52.8-59.2c29.7 0 53.3 26.8 52.8 59.2 0 32.7-23.2 59.2-52.8 59.2"/></svg>
3948    </a>
3949  
3950    
3951    
3952    
3953    
3954      
3955      
3956    
3957    <a href="https://x.com/llmindsetuk" target="_blank" rel="noopener" title="x.com" class="md-social__link">
3958      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.-->
3958<path fill="currentColor" d="M357.2 48h70.6L273.6 224.2 455 464H313L201.7 318.6 74.5 464H3.8l164.9-188.5L-5.2 48h145.6l100.5 132.9zm-24.8 373.8h39.1L119.1 88h-42z"/></svg>
3959    </a>
3960  
3961    
3962    
3963    
3964    
3965      
3966      
3967    
3968    <a href="https://github.com/evalstate" target="_blank" rel="noopener" title="github.com" class="md-social__link">
3969      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.--><path fill="currentColor" d="M216.5 362.5c-66-8-112.5-55.5-112.5-117 0-25 9-52 24-70-6.5-16.5-5.5-51.5 2-66 20-2.5 47 8 63 22.5 19-6 39-9 63.5-9s44.5 3 62.5 8.5c15.5-14 43-24.5 63-22 7 13.5 8 48.5 1.5 65.5 16 19 24.5 44.5 24.5 70.5 0 61.5-46.5 108-113.5 116.5 17 11 28.5 35 28.5 62.5v52c0 15 12.5 23.5 27.5 17.5C441 459.5 512 369 512 257 512 115.5 397 0 255.5 0S0 115.5 0 257c0 111 70.5 203 165.5 237.5 13.5 5 26.5-4 26.5-17.5v-40c-7 3-16 5-24 5-33 0-52.5-18-66.5-51.5-5.5-13.5-11.5-21.5-23-23-6-.5-8-3-8-6 0-6 10-10.5 20-10.5 14.5 0 27 9 40 27.5 10 14.5 20.5 21 33 21s20.5-4.5 32-16c8.5-8.5 15-16 21-21"/></svg>
3970    </a>
3971  
3972</div>
3973      
3974    </div>
3975  </div>
3976</footer>
3977      
3978    </div>
3979    <div class="md-dialog" data-md-component="dialog">
3980      <div class="md-dialog__inner md-typeset"></div>
3981    </div>
3982    
3983    
3984    
3985      
3986      
3987      
3988      
3989        
3990        
3991      
3991<script id="__config" type="application/json">{"annotate":null,"base":"../..","features":["navigation.instant","navigation.tracking","navigation.tabs","navigation.expand","navigation.path","navigation.sections","navigation.top","navigation.footer","content.action.edit","content.action.view","content.code.annotate","content.code.copy","content.code.select","announce.dismiss","search.highlight","search.suggest","content.tabs.link"],"redirect":null,"search":"../../assets/javascripts/workers/search.7d14d953.min.js","tags":null,"translations":{"clipboard.copied":"Copied to clipboard","clipboard.copy":"Copy to clipboard","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.placeholder":"Type to start searching","search.result.term.missing":"Missing","select.version":"Select version"},"version":null}</script>
3991
3992    
3993    
3994      
3994<script src="../../assets/javascripts/bundle.8dcc8e9c.min.js"></script>
3994
3995      
3996        
3996<script src="../../assets/vendor/asciinema-player/asciinema-player.min.js"></script>
3996
3997      
3998        
3998<script src="../../javascripts/asciinema-demos.js"></script>
3998
3999      
4000        
4000<script src="../../javascripts/homepage-benchmark-data.js"></script>
4000
4001      
4002        
4002<script src="../../javascripts/homepage-benchmark.js"></script>
4002
4003      
4004        
4004<script src="../../javascripts/migration-command-converter.js"></script>
4004
4005      
4006    
4007  
4007<script type="module" src="https://static.cloudflareinsights.com/beacon.min.js/v31edd6df95cf4e85bb4c19e7a9bdbcba1788362987495" integrity="sha512-iIg7k2xntmwu6/uSb5tpc/hySgZc4eoL31yB29W6tJFo2akwjPWcEqnCEdJvGexCL0KEQwVYv5BlowfhVz26hg==" data-cf-beacon='{"version":"2024.11.0","token":"ae187409c9cb462dac6fab104347876b","r":1,"spa":2}' crossorigin="anonymous"></script>
4007
4008</body>
4009</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.