Skip to content

Commit 874fee4

Browse files
Unshurestrands-agentzastrowm
authored
docs: add plugins documentation (#573)
Co-authored-by: Strands Agent <217235299+strands-agent@users.noreply.github.com> Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
1 parent 78f6958 commit 874fee4

6 files changed

Lines changed: 674 additions & 43 deletions

File tree

mkdocs.yml

Lines changed: 335 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,335 @@
1+
site_name: Strands Agents SDK
2+
site_description: Documentation for Strands Agents, a simple-to-use, code-first, lightweight library for building AI agents
3+
site_dir: site
4+
site_url: https://strandsagents.com
5+
6+
repo_url: https://github.com/strands-agents/sdk-python
7+
edit_uri: https://github.com/strands-agents/docs/edit/main/docs
8+
9+
theme:
10+
name: material
11+
custom_dir: overrides
12+
logo: assets/logo-light.svg # Safari doesn't support <style> tags inside SVGs so we need to a light and a dark SVG
13+
logo_dark: assets/logo-dark.svg # Safari doesn't support <style> tags inside SVGs so we need to a light and a dark SVG
14+
favicon: assets/logo-auto.svg
15+
favicon_png: assets/logo-light.png # Safari doesn't support SVG favicons
16+
palette:
17+
# Palette toggle for light mode
18+
- media: "(prefers-color-scheme: light)"
19+
primary: custom
20+
scheme: default
21+
toggle:
22+
icon: material/brightness-7
23+
name: Switch to dark mode
24+
# Palette toggle for dark mode
25+
- media: "(prefers-color-scheme: dark)"
26+
primary: custom
27+
scheme: slate
28+
toggle:
29+
icon: material/brightness-4
30+
name: Switch to light mode
31+
icon:
32+
admonition:
33+
code: material/code-json
34+
features:
35+
- content.action.edit
36+
- content.code.copy
37+
- content.tabs.link
38+
- content.code.select
39+
- navigation.indexes
40+
- navigation.instant
41+
- navigation.instant.prefetch
42+
- navigation.instant.progress
43+
- navigation.tabs
44+
- navigation.tabs.sticky
45+
- navigation.sections
46+
- navigation.top
47+
- search.highlight
48+
- content.code.copy
49+
50+
markdown_extensions:
51+
- admonition
52+
- codehilite
53+
- pymdownx.highlight
54+
- pymdownx.tabbed:
55+
alternate_style: true
56+
slugify: !!python/object/apply:pymdownx.slugs.slugify
57+
kwds:
58+
case: lower
59+
- pymdownx.details
60+
- pymdownx.emoji:
61+
emoji_index: !!python/name:material.extensions.emoji.twemoji
62+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
63+
- pymdownx.snippets:
64+
base_path: ["docs"]
65+
check_paths: true
66+
dedent_subsections: true
67+
- pymdownx.superfences:
68+
custom_fences:
69+
- name: mermaid
70+
class: mermaid
71+
format: !!python/name:pymdownx.superfences.fence_code_format
72+
- tables
73+
- toc:
74+
title: On this page
75+
permalink: true
76+
77+
extra_css:
78+
- stylesheets/extra.css
79+
80+
extra_javascript:
81+
# Workaround for site_url breaking mermaid rendering; see the following for more info:
82+
# https://github.com/squidfunk/mkdocs-material/issues/3742#issuecomment-1076068038
83+
- https://unpkg.com/mermaid@11/dist/mermaid.min.js
84+
- assets/auto-redirect.js
85+
86+
nav:
87+
- User Guide:
88+
- Welcome: README.md
89+
- Quickstart:
90+
- Getting Started: user-guide/quickstart/overview.md
91+
- Python: user-guide/quickstart/python.md
92+
- TypeScript: user-guide/quickstart/typescript.md
93+
- Concepts:
94+
- Agents:
95+
- Agent Loop: user-guide/concepts/agents/agent-loop.md
96+
- State: user-guide/concepts/agents/state.md
97+
- Session Management: user-guide/concepts/agents/session-management.md
98+
- Prompts: user-guide/concepts/agents/prompts.md
99+
- Retry Strategies: user-guide/concepts/agents/retry-strategies.md
100+
- Hooks: user-guide/concepts/agents/hooks.md
101+
- Structured Output: user-guide/concepts/agents/structured-output.md
102+
- Conversation Management: user-guide/concepts/agents/conversation-management.md
103+
- Tools:
104+
- Overview: user-guide/concepts/tools/index.md
105+
- Creating Custom Tools: user-guide/concepts/tools/custom-tools.md
106+
- Model Context Protocol (MCP): user-guide/concepts/tools/mcp-tools.md
107+
- Executors: user-guide/concepts/tools/executors.md
108+
- Community Tools Package: user-guide/concepts/tools/community-tools-package.md
109+
- Plugins:
110+
- Overview: user-guide/concepts/plugins/index.md
111+
- Model Providers:
112+
- Overview: user-guide/concepts/model-providers/index.md
113+
- Amazon Bedrock: user-guide/concepts/model-providers/amazon-bedrock.md
114+
- Amazon Nova: user-guide/concepts/model-providers/amazon-nova.md
115+
- Anthropic: user-guide/concepts/model-providers/anthropic.md
116+
- Gemini: user-guide/concepts/model-providers/gemini.md
117+
- LiteLLM: user-guide/concepts/model-providers/litellm.md
118+
- llama.cpp: user-guide/concepts/model-providers/llamacpp.md
119+
- LlamaAPI: user-guide/concepts/model-providers/llamaapi.md
120+
- MistralAI: user-guide/concepts/model-providers/mistral.md
121+
- Ollama: user-guide/concepts/model-providers/ollama.md
122+
- OpenAI: user-guide/concepts/model-providers/openai.md
123+
- SageMaker: user-guide/concepts/model-providers/sagemaker.md
124+
- Writer: user-guide/concepts/model-providers/writer.md
125+
- Custom Providers: user-guide/concepts/model-providers/custom_model_provider.md
126+
- Cohere<sup> community</sup>: user-guide/concepts/model-providers/cohere.md
127+
- CLOVA Studio<sup> community</sup>: user-guide/concepts/model-providers/clova-studio.md
128+
- FireworksAI<sup> community</sup>: user-guide/concepts/model-providers/fireworksai.md
129+
- Nebius Token Factory<sup> community</sup>: user-guide/concepts/model-providers/nebius-token-factory.md
130+
- xAI<sup> community</sup>: user-guide/concepts/model-providers/xai.md
131+
- Streaming:
132+
- Overview: user-guide/concepts/streaming/index.md
133+
- Async Iterators: user-guide/concepts/streaming/async-iterators.md
134+
- Callback Handlers: user-guide/concepts/streaming/callback-handlers.md
135+
- Multi-agent:
136+
- Agent2Agent (A2A): user-guide/concepts/multi-agent/agent-to-agent.md
137+
- Agents as Tools: user-guide/concepts/multi-agent/agents-as-tools.md
138+
- Swarm: user-guide/concepts/multi-agent/swarm.md
139+
- Graph: user-guide/concepts/multi-agent/graph.md
140+
- Workflow: user-guide/concepts/multi-agent/workflow.md
141+
- Multi-agent Patterns: user-guide/concepts/multi-agent/multi-agent-patterns.md
142+
- Interrupts: user-guide/concepts/interrupts.md
143+
- Bidirectional Streaming:
144+
- Quickstart: user-guide/concepts/bidirectional-streaming/quickstart.md
145+
- BidiAgent: user-guide/concepts/bidirectional-streaming/agent.md
146+
- Models:
147+
- Nova Sonic: user-guide/concepts/bidirectional-streaming/models/nova_sonic.md
148+
- Gemini Live: user-guide/concepts/bidirectional-streaming/models/gemini_live.md
149+
- OpenAI Realtime: user-guide/concepts/bidirectional-streaming/models/openai_realtime.md
150+
- IO: user-guide/concepts/bidirectional-streaming/io.md
151+
- Events: user-guide/concepts/bidirectional-streaming/events.md
152+
- Interruptions: user-guide/concepts/bidirectional-streaming/interruption.md
153+
- Hooks: user-guide/concepts/bidirectional-streaming/hooks.md
154+
- Session Management: user-guide/concepts/bidirectional-streaming/session-management.md
155+
- Experimental:
156+
- AgentConfig: user-guide/concepts/experimental/agent-config.md
157+
- Steering: user-guide/concepts/experimental/steering.md
158+
- Safety & Security:
159+
- Responsible AI: user-guide/safety-security/responsible-ai.md
160+
- Guardrails: user-guide/safety-security/guardrails.md
161+
- Prompt Engineering: user-guide/safety-security/prompt-engineering.md
162+
- PII Redaction: user-guide/safety-security/pii-redaction.md
163+
- Observability & Debugging:
164+
- Observability: user-guide/observability-evaluation/observability.md
165+
- Metrics: user-guide/observability-evaluation/metrics.md
166+
- Traces: user-guide/observability-evaluation/traces.md
167+
- Logs: user-guide/observability-evaluation/logs.md
168+
- Strands Evals SDK:
169+
- Getting Started: user-guide/evals-sdk/quickstart.md
170+
- Eval SOP: user-guide/evals-sdk/eval-sop.md
171+
- Evaluators:
172+
- Overview: user-guide/evals-sdk/evaluators/index.md
173+
- Output: user-guide/evals-sdk/evaluators/output_evaluator.md
174+
- Trajectory: user-guide/evals-sdk/evaluators/trajectory_evaluator.md
175+
- Interactions: user-guide/evals-sdk/evaluators/interactions_evaluator.md
176+
- Helpfulness: user-guide/evals-sdk/evaluators/helpfulness_evaluator.md
177+
- Faithfulness: user-guide/evals-sdk/evaluators/faithfulness_evaluator.md
178+
- Goal Success Rate: user-guide/evals-sdk/evaluators/goal_success_rate_evaluator.md
179+
- Tool Selection Accuracy: user-guide/evals-sdk/evaluators/tool_selection_evaluator.md
180+
- Tool Parameter Accuracy: user-guide/evals-sdk/evaluators/tool_parameter_evaluator.md
181+
- Custom: user-guide/evals-sdk/evaluators/custom_evaluator.md
182+
- Experiment Generator: user-guide/evals-sdk/experiment_generator.md
183+
- Simulators:
184+
- Overview: user-guide/evals-sdk/simulators/index.md
185+
- User Simulation: user-guide/evals-sdk/simulators/user_simulation.md
186+
- How-To Guides:
187+
- Experiment Management: user-guide/evals-sdk/how-to/experiment_management.md
188+
- Serialization: user-guide/evals-sdk/how-to/serialization.md
189+
- Deploy:
190+
- Operating Agents in Production: user-guide/deploy/operating-agents-in-production.md
191+
- Amazon Bedrock AgentCore:
192+
- Overview: user-guide/deploy/deploy_to_bedrock_agentcore/index.md
193+
- Python: user-guide/deploy/deploy_to_bedrock_agentcore/python.md
194+
- TypeScript: user-guide/deploy/deploy_to_bedrock_agentcore/typescript.md
195+
- AWS Lambda<sup> new</sup>: user-guide/deploy/deploy_to_aws_lambda.md
196+
- AWS Fargate: user-guide/deploy/deploy_to_aws_fargate.md
197+
- AWS App Runner: user-guide/deploy/deploy_to_aws_apprunner.md
198+
- Amazon EKS: user-guide/deploy/deploy_to_amazon_eks.md
199+
- Amazon EC2: user-guide/deploy/deploy_to_amazon_ec2.md
200+
- Docker:
201+
- Overview: user-guide/deploy/deploy_to_docker/index.md
202+
- Python: user-guide/deploy/deploy_to_docker/python.md
203+
- TypeScript: user-guide/deploy/deploy_to_docker/typescript.md
204+
- Kubernetes: user-guide/deploy/deploy_to_kubernetes.md
205+
- Terraform: user-guide/deploy/deploy_to_terraform.md
206+
- Versioning & Support: user-guide/versioning-and-support.md
207+
208+
- Examples:
209+
- Overview: examples/README.md
210+
- CLI Reference Agent Implementation: examples/python/cli-reference-agent.md
211+
- Weather Forecaster: examples/python/weather_forecaster.md
212+
- Memory Agent: examples/python/memory_agent.md
213+
- File Operations: examples/python/file_operations.md
214+
- Agents Workflows: examples/python/agents_workflows.md
215+
- Knowledge-Base Workflow: examples/python/knowledge_base_agent.md
216+
- Structured Output: examples/python/structured_output.md
217+
- Multi Agents: examples/python/multi_agent_example/multi_agent_example.md
218+
- Cyclic Graph: examples/python/graph_loops_example.md
219+
- Meta Tooling: examples/python/meta_tooling.md
220+
- MCP: examples/python/mcp_calculator.md
221+
- Multi-modal: examples/python/multimodal.md
222+
223+
- Community:
224+
- Community Catalog: community/community-packages.md
225+
- Get Featured: community/get-featured.md
226+
- Integrations:
227+
- AG-UI: community/integrations/ag-ui.md
228+
- Model Providers:
229+
- Cohere: community/model-providers/cohere.md
230+
- CLOVA Studio: community/model-providers/clova-studio.md
231+
- Fireworks AI: community/model-providers/fireworksai.md
232+
- Nebius Token Factory: community/model-providers/nebius-token-factory.md
233+
- NVIDIA NIM: community/model-providers/nvidia-nim.md
234+
- SGLang: community/model-providers/sglang.md
235+
- vLLM: community/model-providers/vllm.md
236+
- MLX: community/model-providers/mlx.md
237+
- xAI: community/model-providers/xai.md
238+
- Session Managers:
239+
- Amazon AgentCore Memory: community/session-managers/agentcore-memory.md
240+
- Valkey/Redis: community/session-managers/strands-valkey-session-manager.md
241+
- Tool Protocols:
242+
- UTCP: community/tools/utcp.md
243+
- Tools:
244+
- deepgram: community/tools/strands-deepgram.md
245+
- hubspot: community/tools/strands-hubspot.md
246+
- teams: community/tools/strands-teams.md
247+
- telegram: community/tools/strands-telegram.md
248+
- telegram-listener: community/tools/strands-telegram-listener.md
249+
250+
- Contribute ❤️:
251+
- Overview: contribute/index.md
252+
- Contribution Types:
253+
- SDK: contribute/contributing/core-sdk.md
254+
- Documentation: contribute/contributing/documentation.md
255+
- Feature Proposals: contribute/contributing/feature-proposals.md
256+
- Extensions: contribute/contributing/extensions.md
257+
- Python API: []
258+
- TypeScript API: api-reference/typescript/index.html
259+
260+
exclude_docs: |
261+
node_modules
262+
.venv
263+
_dependencies
264+
!.lycheeignore
265+
266+
plugins:
267+
- search
268+
- privacy
269+
- macros:
270+
module_name: macros
271+
- mike:
272+
alias_type: symlink
273+
canonical_version: latest
274+
- mkdocstrings:
275+
handlers:
276+
python:
277+
options:
278+
docstring_style: google
279+
show_root_heading: true
280+
show_source: true
281+
- llmstxt:
282+
full_output: llms-full.txt
283+
sections:
284+
User Guide:
285+
- README.md
286+
- user-guide/**/*.md
287+
Community:
288+
- community/**/*.md
289+
Examples:
290+
- examples/**/*.md
291+
Python API:
292+
- docs/api-reference/python/**/*.md
293+
TypeScript API:
294+
- docs/api-reference/typescript/*.html
295+
296+
297+
hooks:
298+
- build-ts-docs.py
299+
- build-py-docs.py
300+
extra:
301+
social:
302+
- icon: fontawesome/brands/github
303+
version:
304+
provider: mike
305+
# Variables
306+
docs_repo: https://github.com/strands-agents/docs/tree/main
307+
sdk_pypi: https://pypi.org/project/strands-agents/
308+
sdk_repo: https://github.com/strands-agents/sdk-python/blob/main
309+
py_sdk_repo_home: https://github.com/strands-agents/sdk-python/blob/main
310+
ts_sdk_repo_home: https://github.com/strands-agents/sdk-typescript/blob/main
311+
tools_pypi: https://pypi.org/project/strands-agents-tools/
312+
tools_repo: https://github.com/strands-agents/tools/blob/main
313+
tools_repo_home: https://github.com/strands-agents/tools
314+
agent_builder_pypi: https://pypi.org/project/strands-agents-builder/
315+
agent_builder_repo_home: https://github.com/strands-agents/agent-builder
316+
317+
link_strands_tools: "[`strands-agents-tools`](https://github.com/strands-agents/tools)"
318+
link_strands_builder: "[`strands-agents-builder`](https://github.com/strands-agents/agent-builder)"
319+
community_contribution_banner: |
320+
!!! info "Community Contribution"
321+
This is a community-maintained package that is not owned or supported by the Strands team. Validate and review
322+
the package before using it in your project.
323+
324+
Have your own integration? [We'd love to add it here too!](https://github.com/strands-agents/docs/issues/new?assignees=&labels=enhancement&projects=&template=content_addition.yml&title=%5BContent+Addition%5D%3A+)
325+
326+
validation:
327+
nav:
328+
omitted_files: info
329+
not_found: warn
330+
absolute_links: warn
331+
links:
332+
not_found: warn
333+
anchors: warn
334+
absolute_links: warn
335+
unrecognized_links: warn

src/config/navigation.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ sidebar:
6262
- docs/user-guide/concepts/tools/mcp-tools
6363
- docs/user-guide/concepts/tools/executors
6464
- docs/user-guide/concepts/tools/community-tools-package
65+
- label: Plugins
66+
items:
67+
- docs/user-guide/concepts/plugins
6568
- label: Model Providers
6669
items:
6770
- docs/user-guide/concepts/model-providers

src/content/docs/community/get-featured.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Place your documentation in the right spot:
3333
| Model Providers | `community/model-providers/` | `cohere.md` |
3434
| Tools | `community/tools/` | `strands-deepgram.md` |
3535
| Session Managers | `community/session-managers/` | `agentcore-memory.md` |
36+
| Plugins | `community/plugins/` | `my-plugin.md` |
3637
| Integrations | `community/integrations/` | `ag-ui.md` |
3738

3839
## Document Layout

0 commit comments

Comments
 (0)