fast-agent-mcp 0.4.7__py3-none-any.whl

fast_agent_mcp-0.4.7.dist-info/METADATA

@@ -0,0 +1,788 @@
+Metadata-Version: 2.4
+Name: fast-agent-mcp
+Version: 0.4.7
+Summary: Define, Prompt and Test MCP enabled Agents and Workflows
+Author-email: Shaun Smith <fastagent@llmindset.co.uk>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+        1.  Definitions.
+        
+            "License" shall mean the terms and conditions for use, reproduction,
+            and distribution as defined by Sections 1 through 9 of this document.
+        
+            "Licensor" shall mean the copyright owner or entity authorized by
+            the copyright owner that is granting the License.
+        
+            "Legal Entity" shall mean the union of the acting entity and all
+            other entities that control, are controlled by, or are under common
+            control with that entity. For the purposes of this definition,
+            "control" means (i) the power, direct or indirect, to cause the
+            direction or management of such entity, whether by contract or
+            otherwise, or (ii) ownership of fifty percent (50%) or more of the
+            outstanding shares, or (iii) beneficial ownership of such entity.
+        
+            "You" (or "Your") shall mean an individual or Legal Entity
+            exercising permissions granted by this License.
+        
+            "Source" form shall mean the preferred form for making modifications,
+            including but not limited to software source code, documentation
+            source, and configuration files.
+        
+            "Object" form shall mean any form resulting from mechanical
+            transformation or translation of a Source form, including but
+            not limited to compiled object code, generated documentation,
+            and conversions to other media types.
+        
+            "Work" shall mean the work of authorship, whether in Source or
+            Object form, made available under the License, as indicated by a
+            copyright notice that is included in or attached to the work
+            (an example is provided in the Appendix below).
+        
+            "Derivative Works" shall mean any work, whether in Source or Object
+            form, that is based on (or derived from) the Work and for which the
+            editorial revisions, annotations, elaborations, or other modifications
+            represent, as a whole, an original work of authorship. For the purposes
+            of this License, Derivative Works shall not include works that remain
+            separable from, or merely link (or bind by name) to the interfaces of,
+            the Work and Derivative Works thereof.
+        
+            "Contribution" shall mean any work of authorship, including
+            the original version of the Work and any modifications or additions
+            to that Work or Derivative Works thereof, that is intentionally
+            submitted to Licensor for inclusion in the Work by the copyright owner
+            or by an individual or Legal Entity authorized to submit on behalf of
+            the copyright owner. For the purposes of this definition, "submitted"
+            means any form of electronic, verbal, or written communication sent
+            to the Licensor or its representatives, including but not limited to
+            communication on electronic mailing lists, source code control systems,
+            and issue tracking systems that are managed by, or on behalf of, the
+            Licensor for the purpose of discussing and improving the Work, but
+            excluding communication that is conspicuously marked or otherwise
+            designated in writing by the copyright owner as "Not a Contribution."
+        
+            "Contributor" shall mean Licensor and any individual or Legal Entity
+            on behalf of whom a Contribution has been received by Licensor and
+            subsequently incorporated within the Work.
+        
+        2.  Grant of Copyright License. Subject to the terms and conditions of
+            this License, each Contributor hereby grants to You a perpetual,
+            worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+            copyright license to reproduce, prepare Derivative Works of,
+            publicly display, publicly perform, sublicense, and distribute the
+            Work and such Derivative Works in Source or Object form.
+        
+        3.  Grant of Patent License. Subject to the terms and conditions of
+            this License, each Contributor hereby grants to You a perpetual,
+            worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+            (except as stated in this section) patent license to make, have made,
+            use, offer to sell, sell, import, and otherwise transfer the Work,
+            where such license applies only to those patent claims licensable
+            by such Contributor that are necessarily infringed by their
+            Contribution(s) alone or by combination of their Contribution(s)
+            with the Work to which such Contribution(s) was submitted. If You
+            institute patent litigation against any entity (including a
+            cross-claim or counterclaim in a lawsuit) alleging that the Work
+            or a Contribution incorporated within the Work constitutes direct
+            or contributory patent infringement, then any patent licenses
+            granted to You under this License for that Work shall terminate
+            as of the date such litigation is filed.
+        
+        4.  Redistribution. You may reproduce and distribute copies of the
+            Work or Derivative Works thereof in any medium, with or without
+            modifications, and in Source or Object form, provided that You
+            meet the following conditions:
+        
+            (a) You must give any other recipients of the Work or
+            Derivative Works a copy of this License; and
+        
+            (b) You must cause any modified files to carry prominent notices
+            stating that You changed the files; and
+        
+            (c) You must retain, in the Source form of any Derivative Works
+            that You distribute, all copyright, patent, trademark, and
+            attribution notices from the Source form of the Work,
+            excluding those notices that do not pertain to any part of
+            the Derivative Works; and
+        
+            (d) If the Work includes a "NOTICE" text file as part of its
+            distribution, then any Derivative Works that You distribute must
+            include a readable copy of the attribution notices contained
+            within such NOTICE file, excluding those notices that do not
+            pertain to any part of the Derivative Works, in at least one
+            of the following places: within a NOTICE text file distributed
+            as part of the Derivative Works; within the Source form or
+            documentation, if provided along with the Derivative Works; or,
+            within a display generated by the Derivative Works, if and
+            wherever such third-party notices normally appear. The contents
+            of the NOTICE file are for informational purposes only and
+            do not modify the License. You may add Your own attribution
+            notices within Derivative Works that You distribute, alongside
+            or as an addendum to the NOTICE text from the Work, provided
+            that such additional attribution notices cannot be construed
+            as modifying the License.
+        
+            You may add Your own copyright statement to Your modifications and
+            may provide additional or different license terms and conditions
+            for use, reproduction, or distribution of Your modifications, or
+            for any such Derivative Works as a whole, provided Your use,
+            reproduction, and distribution of the Work otherwise complies with
+            the conditions stated in this License.
+        
+        5.  Submission of Contributions. Unless You explicitly state otherwise,
+            any Contribution intentionally submitted for inclusion in the Work
+            by You to the Licensor shall be under the terms and conditions of
+            this License, without any additional terms or conditions.
+            Notwithstanding the above, nothing herein shall supersede or modify
+            the terms of any separate license agreement you may have executed
+            with Licensor regarding such Contributions.
+        
+        6.  Trademarks. This License does not grant permission to use the trade
+            names, trademarks, service marks, or product names of the Licensor,
+            except as required for reasonable and customary use in describing the
+            origin of the Work and reproducing the content of the NOTICE file.
+        
+        7.  Disclaimer of Warranty. Unless required by applicable law or
+            agreed to in writing, Licensor provides the Work (and each
+            Contributor provides its Contributions) on an "AS IS" BASIS,
+            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+            implied, including, without limitation, any warranties or conditions
+            of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+            PARTICULAR PURPOSE. You are solely responsible for determining the
+            appropriateness of using or redistributing the Work and assume any
+            risks associated with Your exercise of permissions under this License.
+        
+        8.  Limitation of Liability. In no event and under no legal theory,
+            whether in tort (including negligence), contract, or otherwise,
+            unless required by applicable law (such as deliberate and grossly
+            negligent acts) or agreed to in writing, shall any Contributor be
+            liable to You for damages, including any direct, indirect, special,
+            incidental, or consequential damages of any character arising as a
+            result of this License or out of the use or inability to use the
+            Work (including but not limited to damages for loss of goodwill,
+            work stoppage, computer failure or malfunction, or any and all
+            other commercial damages or losses), even if such Contributor
+            has been advised of the possibility of such damages.
+        
+        9.  Accepting Warranty or Additional Liability. While redistributing
+            the Work or Derivative Works thereof, You may choose to offer,
+            and charge a fee for, acceptance of support, warranty, indemnity,
+            or other liability obligations and/or rights consistent with this
+            License. However, in accepting such obligations, You may act only
+            on Your own behalf and on Your sole responsibility, not on behalf
+            of any other Contributor, and only if You agree to indemnify,
+            defend, and hold each Contributor harmless for any liability
+            incurred by, or claims asserted against, such Contributor by reason
+            of your accepting any such warranty or additional liability.
+        
+        END OF TERMS AND CONDITIONS
+        
+        APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+        Copyright 2025 llmindset.co.uk
+        
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <3.14,>=3.13.5
+Requires-Dist: a2a-sdk>=0.3.16
+Requires-Dist: agent-client-protocol>=0.7.0
+Requires-Dist: aiohttp>=3.13.2
+Requires-Dist: anthropic>=0.75
+Requires-Dist: deprecated>=1.2.18
+Requires-Dist: email-validator>=2.2.0
+Requires-Dist: fastapi>=0.121.0
+Requires-Dist: google-genai>=1.52.0
+Requires-Dist: keyring>=24.3.1
+Requires-Dist: mcp==1.23.1
+Requires-Dist: openai[aiohttp]>=2.9
+Requires-Dist: opentelemetry-distro>=0.55b0
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.7.0
+Requires-Dist: opentelemetry-instrumentation-anthropic>=0.49.5; python_version >= '3.10' and python_version < '4.0'
+Requires-Dist: opentelemetry-instrumentation-google-genai>=0.4b0
+Requires-Dist: opentelemetry-instrumentation-mcp>=0.49.5; python_version >= '3.10' and python_version < '4.0'
+Requires-Dist: opentelemetry-instrumentation-openai>=0.49.5; python_version >= '3.10' and python_version < '4.0'
+Requires-Dist: prompt-toolkit>=3.0.52
+Requires-Dist: pydantic-settings>=2.7.0
+Requires-Dist: pydantic>=2.10.4
+Requires-Dist: pyperclip>=1.9.0
+Requires-Dist: python-frontmatter>=1.1.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=14.2.0
+Requires-Dist: tiktoken>=0.12.0
+Requires-Dist: typer>=0.20.0
+Provides-Extra: all-providers
+Requires-Dist: azure-identity>=1.14.0; extra == 'all-providers'
+Requires-Dist: boto3>=1.35.0; extra == 'all-providers'
+Requires-Dist: tensorzero>=2025.7.5; extra == 'all-providers'
+Provides-Extra: azure
+Requires-Dist: azure-identity>=1.14.0; extra == 'azure'
+Provides-Extra: bedrock
+Requires-Dist: boto3>=1.35.0; extra == 'bedrock'
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.0.1; extra == 'dev'
+Requires-Dist: pydantic>=2.10.4; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.1; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: pyyaml>=6.0.2; extra == 'dev'
+Requires-Dist: ruamel-yaml>=0.18.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.4; extra == 'dev'
+Provides-Extra: tensorzero
+Requires-Dist: tensorzero>=2025.7.5; extra == 'tensorzero'
+Provides-Extra: textual
+Requires-Dist: textual>=6.2.1; extra == 'textual'
+Description-Content-Type: text/markdown
+
+<p align="center">
+<a href="https://pypi.org/project/fast-agent-mcp/"><img src="https://img.shields.io/pypi/v/fast-agent-mcp?color=%2334D058&label=pypi" /></a>
+<a href="#"><img src="https://github.com/evalstate/fast-agent/actions/workflows/main-checks.yml/badge.svg" /></a>
+<a href="https://github.com/evalstate/fast-agent/issues"><img src="https://img.shields.io/github/issues-raw/evalstate/fast-agent" /></a>
+<a href="https://discord.gg/xg5cJ7ndN6"><img src="https://img.shields.io/discord/1358470293990936787" alt="discord" /></a>
+<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/fast-agent-mcp?label=pypi%20%7C%20downloads"/>
+<a href="https://github.com/evalstate/fast-agent-mcp/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/fast-agent-mcp" /></a>
+</p>
+
+## Overview
+
+> [!TIP]
+> Please see : https://fast-agent.ai for latest documentation. There is also an LLMs.txt [here](https://fast-agent.ai/llms.txt)
+
+**`fast-agent`** enables you to create and interact with sophisticated multimodal Agents and Workflows in minutes. It is the first framework with complete, end-to-end tested MCP Feature support including Sampling and Elicitations.
+
+<!-- ![multi_model_trim](https://github.com/user-attachments/assets/c8bf7474-2c41-4ef3-8924-06e29907d7c6) -->
+
+The simple declarative syntax lets you concentrate on composing your Prompts and MCP Servers to [build effective agents](https://www.anthropic.com/research/building-effective-agents).
+
+Model support is comprehensive with native support for Anthropic, OpenAI and Google providers as well as Azure, Ollama, Deepseek and dozens of others via TensorZero. Structured Outputs, PDF and Vision support is simple to use and well tested. Passthrough and Playback LLMs enable rapid development and test of Python glue-code for your applications.
+
+Recent features include:
+ - Agent Skills (SKILL.md)
+ - MCP-UI Support |
+ - OpenAI Apps SDK (Skybridge)
+ - Shell Mode
+ - Advanced MCP Transport Diagnsotics
+ - MCP Elicitations
+
+<img width="800"  alt="MCP Transport Diagnostics" src="https://github.com/user-attachments/assets/e26472de-58d9-4726-8bdd-01eb407414cf" />
+
+
+`fast-agent` is the only tool that allows you to inspect Streamable HTTP Transport usage - a critical feature for ensuring reliable, compliant deployments. OAuth is supported with KeyRing storage for secrets. Use the `fast-agent auth` command to manage.
+
+
+
+
+
+> [!IMPORTANT]
+>
+> `fast-agent` The fast-agent documentation repo is here: https://github.com/evalstate/fast-agent-docs. Please feel free to submit PRs for documentation, experience reports or other content you think others may find helpful. All help and feedback warmly received.
+
+### Agent Application Development
+
+Prompts and configurations that define your Agent Applications are stored in simple files, with minimal boilerplate, enabling simple management and version control.
+
+Chat with individual Agents and Components before, during and after workflow execution to tune and diagnose your application. Agents can request human input to get additional context for task completion.
+
+Simple model selection makes testing Model <-> MCP Server interaction painless. You can read more about the motivation behind this project [here](https://llmindset.co.uk/resources/fast-agent/)
+
+![2025-03-23-fast-agent](https://github.com/user-attachments/assets/8f6dbb69-43e3-4633-8e12-5572e9614728)
+
+## Get started:
+
+Start by installing the [uv package manager](https://docs.astral.sh/uv/) for Python. Then:
+
+```bash
+uv pip install fast-agent-mcp          # install fast-agent!
+fast-agent go                          # start an interactive session
+fast-agent go --url https://hf.co/mcp  # with a remote MCP
+fast-agent go --model=generic.qwen2.5  # use ollama qwen 2.5
+fast-agent setup                       # create an example agent and config files
+uv run agent.py                        # run your first agent
+uv run agent.py --model=o3-mini.low    # specify a model
+uv run agent.py --transport http --port 8001  # expose as MCP server (server mode implied)
+fast-agent quickstart workflow  # create "building effective agents" examples
+```
+
+`--server` remains available for backward compatibility but is deprecated; `--transport` now automatically switches an agent into server mode.
+
+Other quickstart examples include a Researcher Agent (with Evaluator-Optimizer workflow) and Data Analysis Agent (similar to the ChatGPT experience), demonstrating MCP Roots support.
+
+> [!TIP]
+> Windows Users - there are a couple of configuration changes needed for the Filesystem and Docker MCP Servers - necessary changes are detailed within the configuration files.
+
+### Basic Agents
+
+Defining an agent is as simple as:
+
+```python
+@fast.agent(
+  instruction="Given an object, respond only with an estimate of its size."
+)
+```
+
+We can then send messages to the Agent:
+
+```python
+async with fast.run() as agent:
+  moon_size = await agent("the moon")
+  print(moon_size)
+```
+
+Or start an interactive chat with the Agent:
+
+```python
+async with fast.run() as agent:
+  await agent.interactive()
+```
+
+Here is the complete `sizer.py` Agent application, with boilerplate code:
+
+```python
+import asyncio
+from fast_agent import FastAgent
+
+# Create the application
+fast = FastAgent("Agent Example")
+
+@fast.agent(
+  instruction="Given an object, respond only with an estimate of its size."
+)
+async def main():
+  async with fast.run() as agent:
+    await agent.interactive()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+The Agent can then be run with `uv run sizer.py`.
+
+Specify a model with the `--model` switch - for example `uv run sizer.py --model sonnet`.
+
+### Combining Agents and using MCP Servers
+
+_To generate examples use `fast-agent quickstart workflow`. This example can be run with `uv run workflow/chaining.py`. fast-agent looks for configuration files in the current directory before checking parent directories recursively._
+
+Agents can be chained to build a workflow, using MCP Servers defined in the `fastagent.config.yaml` file:
+
+```python
+@fast.agent(
+    "url_fetcher",
+    "Given a URL, provide a complete and comprehensive summary",
+    servers=["fetch"], # Name of an MCP Server defined in fastagent.config.yaml
+)
+@fast.agent(
+    "social_media",
+    """
+    Write a 280 character social media post for any given text.
+    Respond only with the post, never use hashtags.
+    """,
+)
+@fast.chain(
+    name="post_writer",
+    sequence=["url_fetcher", "social_media"],
+)
+async def main():
+    async with fast.run() as agent:
+        # using chain workflow
+        await agent.post_writer("http://llmindset.co.uk")
+```
+
+All Agents and Workflows respond to `.send("message")` or `.prompt()` to begin a chat session.
+
+Saved as `social.py` we can now run this workflow from the command line with:
+
+```bash
+uv run workflow/chaining.py --agent post_writer --message "<url>"
+```
+
+Add the `--quiet` switch to disable progress and message display and return only the final response - useful for simple automations.
+
+### Agents-as-Tools (child agents as tools)
+
+Sometimes one agent needs to call other agents as tools. `fast-agent` supports
+this via a hybrid *Agents-as-Tools* agent:
+
+- You declare a BASIC agent with `agents=[...]`.
+- At runtime it is instantiated as an internal `AgentsAsToolsAgent`, which:
+  - Inherits from `McpAgent` (keeps its own MCP servers/tools).
+  - Exposes each child agent as a tool (`agent__ChildName`).
+  - Merges MCP tools and agent-tools in a single `list_tools()` surface.
+  - Supports history/parallel controls:
+    - `history_mode` (default `fork`; `fork_and_merge` to merge clone history back)
+    - `max_parallel` (default unlimited), `child_timeout_sec` (default none)
+    - `max_display_instances` (default 20; collapse progress after top-N)
+
+Minimal example:
+
+```python
+@fast.agent(
+    name="NY-Project-Manager",
+    instruction="Return current time and project status.",
+    servers=["time"],  # MCP server 'time' configured in fastagent.config.yaml
+)
+@fast.agent(
+    name="London-Project-Manager",
+    instruction="Return current time and news.",
+    servers=["time"],
+)
+@fast.agent(
+    name="PMO-orchestrator",
+    instruction="Get reports. Separate call per topic. NY: {OpenAI, Fast-Agent, Anthropic}, London: Economics",
+    default=True,
+    agents=[
+        "NY-Project-Manager",
+        "London-Project-Manager",
+    ],  # children are exposed as tools: agent__NY-Project-Manager, agent__London-Project-Manager
+    # optional knobs:
+    #   history_mode=HistoryMode.FORK_AND_MERGE to merge clone history back
+    #   max_parallel=8 to cap parallel agent-tools
+    #   child_timeout_sec=600 to bound each child call
+    #   max_display_instances=10 to collapse progress UI after top-N
+)
+async def main() -> None:
+    async with fast.run() as agent:
+        result = await agent("Get PMO report")
+        print(result)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Extended example is available in the repository as
+`examples/workflows/agents_as_tools_extended.py`.
+
+## MCP OAuth (v2.1)
+
+For SSE and HTTP MCP servers, OAuth is enabled by default with minimal configuration. A local callback server is used to capture the authorization code, with a paste-URL fallback if the port is unavailable.
+
+- Minimal per-server settings in `fastagent.config.yaml`:
+
+```yaml
+mcp:
+  servers:
+    myserver:
+      transport: http # or sse
+      url: http://localhost:8001/mcp # or /sse for SSE servers
+      auth:
+        oauth: true # default: true
+        redirect_port: 3030 # default: 3030
+        redirect_path: /callback # default: /callback
+        # scope: "user"       # optional; if omitted, server defaults are used
+```
+
+- The OAuth client uses PKCE and in-memory token storage (no tokens written to disk).
+- Token persistence: by default, tokens are stored securely in your OS keychain via `keyring`. If a keychain is unavailable (e.g., headless container), in-memory storage is used for the session.
+- To force in-memory only per server, set:
+
+```yaml
+mcp:
+  servers:
+    myserver:
+      transport: http
+      url: http://localhost:8001/mcp
+      auth:
+        oauth: true
+        persist: memory
+```
+
+- To disable OAuth for a specific server , set `auth.oauth: false` for that server.
+
+## Workflows
+
+### Chain
+
+The `chain` workflow offers a more declarative approach to calling Agents in sequence:
+
+```python
+
+@fast.chain(
+  "post_writer",
+   sequence=["url_fetcher","social_media"]
+)
+
+# we can them prompt it directly:
+async with fast.run() as agent:
+  await agent.post_writer()
+
+```
+
+This starts an interactive session, which produces a short social media post for a given URL. If a _chain_ is prompted it returns to a chat with last Agent in the chain. You can switch the agent to prompt by typing `@agent-name`.
+
+Chains can be incorporated in other workflows, or contain other workflow elements (including other Chains). You can set an `instruction` to precisely describe it's capabilities to other workflow steps if needed.
+
+### Human Input
+
+Agents can request Human Input to assist with a task or get additional context:
+
+```python
+@fast.agent(
+    instruction="An AI agent that assists with basic tasks. Request Human Input when needed.",
+    human_input=True,
+)
+
+await agent("print the next number in the sequence")
+```
+
+In the example `human_input.py`, the Agent will prompt the User for additional information to complete the task.
+
+### Parallel
+
+The Parallel Workflow sends the same message to multiple Agents simultaneously (`fan-out`), then uses the `fan-in` Agent to process the combined content.
+
+```python
+@fast.agent("translate_fr", "Translate the text to French")
+@fast.agent("translate_de", "Translate the text to German")
+@fast.agent("translate_es", "Translate the text to Spanish")
+
+@fast.parallel(
+  name="translate",
+  fan_out=["translate_fr","translate_de","translate_es"]
+)
+
+@fast.chain(
+  "post_writer",
+   sequence=["url_fetcher","social_media","translate"]
+)
+```
+
+If you don't specify a `fan-in` agent, the `parallel` returns the combined Agent results verbatim.
+
+`parallel` is also useful to ensemble ideas from different LLMs.
+
+When using `parallel` in other workflows, specify an `instruction` to describe its operation.
+
+### Evaluator-Optimizer
+
+Evaluator-Optimizers combine 2 agents: one to generate content (the `generator`), and the other to judge that content and provide actionable feedback (the `evaluator`). Messages are sent to the generator first, then the pair run in a loop until either the evaluator is satisfied with the quality, or the maximum number of refinements is reached. The final result from the Generator is returned.
+
+If the Generator has `use_history` off, the previous iteration is returned when asking for improvements - otherwise conversational context is used.
+
+```python
+@fast.evaluator_optimizer(
+  name="researcher",
+  generator="web_searcher",
+  evaluator="quality_assurance",
+  min_rating="EXCELLENT",
+  max_refinements=3
+)
+
+async with fast.run() as agent:
+  await agent.researcher.send("produce a report on how to make the perfect espresso")
+```
+
+When used in a workflow, it returns the last `generator` message as the result.
+
+See the `evaluator.py` workflow example, or `fast-agent quickstart researcher` for a more complete example.
+
+### Router
+
+Routers use an LLM to assess a message, and route it to the most appropriate Agent. The routing prompt is automatically generated based on the Agent instructions and available Servers.
+
+```python
+@fast.router(
+  name="route",
+  agents=["agent1","agent2","agent3"]
+)
+```
+
+Look at the `router.py` workflow for an example.
+
+### Orchestrator
+
+Given a complex task, the Orchestrator uses an LLM to generate a plan to divide the task amongst the available Agents. The planning and aggregation prompts are generated by the Orchestrator, which benefits from using more capable models. Plans can either be built once at the beginning (`plan_type="full"`) or iteratively (`plan_type="iterative"`).
+
+```python
+@fast.orchestrator(
+  name="orchestrate",
+  agents=["task1","task2","task3"]
+)
+```
+
+See the `orchestrator.py` or `agent_build.py` workflow example.
+
+## Agent Features
+
+### Calling Agents
+
+All definitions allow omitting the name and instructions arguments for brevity:
+
+```python
+@fast.agent("You are a helpful agent")          # Create an agent with a default name.
+@fast.agent("greeter","Respond cheerfully!")    # Create an agent with the name "greeter"
+
+moon_size = await agent("the moon")             # Call the default (first defined agent) with a message
+
+result = await agent.greeter("Good morning!")   # Send a message to an agent by name using dot notation
+result = await agent.greeter.send("Hello!")     # You can call 'send' explicitly
+
+await agent.greeter()                           # If no message is specified, a chat session will open
+await agent.greeter.prompt()                    # that can be made more explicit
+await agent.greeter.prompt(default_prompt="OK") # and supports setting a default prompt
+
+agent["greeter"].send("Good Evening!")          # Dictionary access is supported if preferred
+```
+
+### Defining Agents
+
+#### Basic Agent
+
+```python
+@fast.agent(
+  name="agent",                          # name of the agent
+  instruction="You are a helpful Agent", # base instruction for the agent
+  servers=["filesystem"],                # list of MCP Servers for the agent
+  model="o3-mini.high",                  # specify a model for the agent
+  use_history=True,                      # agent maintains chat history
+  request_params=RequestParams(temperature= 0.7), # additional parameters for the LLM (or RequestParams())
+  human_input=True,                      # agent can request human input
+)
+```
+
+#### Chain
+
+```python
+@fast.chain(
+  name="chain",                          # name of the chain
+  sequence=["agent1", "agent2", ...],    # list of agents in execution order
+  instruction="instruction",             # instruction to describe the chain for other workflows
+  cumulative=False,                      # whether to accumulate messages through the chain
+  continue_with_final=True,              # open chat with agent at end of chain after prompting
+)
+```
+
+#### Parallel
+
+```python
+@fast.parallel(
+  name="parallel",                       # name of the parallel workflow
+  fan_out=["agent1", "agent2"],          # list of agents to run in parallel
+  fan_in="aggregator",                   # name of agent that combines results (optional)
+  instruction="instruction",             # instruction to describe the parallel for other workflows
+  include_request=True,                  # include original request in fan-in message
+)
+```
+
+#### Evaluator-Optimizer
+
+```python
+@fast.evaluator_optimizer(
+  name="researcher",                     # name of the workflow
+  generator="web_searcher",              # name of the content generator agent
+  evaluator="quality_assurance",         # name of the evaluator agent
+  min_rating="GOOD",                     # minimum acceptable quality (EXCELLENT, GOOD, FAIR, POOR)
+  max_refinements=3,                     # maximum number of refinement iterations
+)
+```
+
+#### Router
+
+```python
+@fast.router(
+  name="route",                          # name of the router
+  agents=["agent1", "agent2", "agent3"], # list of agent names router can delegate to
+  model="o3-mini.high",                  # specify routing model
+  use_history=False,                     # router maintains conversation history
+  human_input=False,                     # whether router can request human input
+)
+```
+
+#### Orchestrator
+
+```python
+@fast.orchestrator(
+  name="orchestrator",                   # name of the orchestrator
+  instruction="instruction",             # base instruction for the orchestrator
+  agents=["agent1", "agent2"],           # list of agent names this orchestrator can use
+  model="o3-mini.high",                  # specify orchestrator planning model
+  use_history=False,                     # orchestrator doesn't maintain chat history (no effect).
+  human_input=False,                     # whether orchestrator can request human input
+  plan_type="full",                      # planning approach: "full" or "iterative"
+  plan_iterations=5,                     # maximum number of full plan attempts, or iterations
+)
+```
+
+### Multimodal Support
+
+Add Resources to prompts using either the inbuilt `prompt-server` or MCP Types directly. Convenience class are made available to do so simply, for example:
+
+```python
+  summary: str =  await agent.with_resource(
+      "Summarise this PDF please",
+      "mcp_server",
+      "resource://fast-agent/sample.pdf",
+  )
+```
+
+#### MCP Tool Result Conversion
+
+LLM APIs have restrictions on the content types that can be returned as Tool Calls/Function results via their Chat Completions API's:
+
+- OpenAI supports Text
+- Anthropic supports Text and Image
+- Google supports Text, Image, PDF, and Video (e.g., `video/mp4`).
+  > **Note**: Inline video data is limited to 20MB. For larger files, use the File API. YouTube URLs are supported directly.
+
+For MCP Tool Results, `ImageResources` and `EmbeddedResources` are converted to User Messages and added to the conversation.
+
+### Prompts
+
+MCP Prompts are supported with `apply_prompt(name,arguments)`, which always returns an Assistant Message. If the last message from the MCP Server is a 'User' message, it is sent to the LLM for processing. Prompts applied to the Agent's Context are retained - meaning that with `use_history=False`, Agents can act as finely tuned responders.
+
+Prompts can also be applied interactively through the interactive interface by using the `/prompt` command.
+
+### Sampling
+
+Sampling LLMs are configured per Client/Server pair. Specify the model name in fastagent.config.yaml as follows:
+
+```yaml
+mcp:
+  servers:
+    sampling_resource:
+      command: "uv"
+      args: ["run", "sampling_resource_server.py"]
+      sampling:
+        model: "haiku"
+```
+
+### Secrets File
+
+> [!TIP]
+> fast-agent will look recursively for a fastagent.secrets.yaml file, so you only need to manage this at the root folder of your agent definitions.
+
+### Interactive Shell
+
+![fast-agent](https://github.com/user-attachments/assets/3e692103-bf97-489a-b519-2d0fee036369)
+
+## Project Notes
+
+`fast-agent` builds on the [`mcp-agent`](https://github.com/lastmile-ai/mcp-agent) project by Sarmad Qadri.
+
+### Contributing
+
+Contributions and PRs are welcome - feel free to raise issues to discuss. Full guidelines for contributing and roadmap coming very soon. Get in touch!