Skip to content

Commit fcfdd6c

Browse files
committed
Updates to README
1 parent 51403b8 commit fcfdd6c

File tree

1 file changed

+95
-19
lines changed

1 file changed

+95
-19
lines changed

README.md

Lines changed: 95 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,14 @@
88
<p align="center">
99
<a href="https://github.com/lastmile-ai/mcp-agent/tree/main/examples" target="_blank"><strong>Examples</strong></a>
1010
|
11-
<a href="https://www.anthropic.com/research/building-effective-agents" target="_blank"><strong>Building Effective Agents</strong></a>
11+
<a href="https://docs.mcp-agent.com/mcp-agent-sdk/effective-patterns/overview" target="_blank"><strong>Building Effective Agents</strong></a>
1212
|
1313
<a href="https://modelcontextprotocol.io/introduction" target="_blank"><strong>MCP</strong></a>
1414
</p>
1515

1616
<p align="center">
1717
<a href="https://docs.mcp-agent.com"><img src="https://img.shields.io/badge/docs-8F?style=flat&link=https%3A%2F%2Fdocs.mcp-agent.com%2F" /><a/>
1818
<a href="https://pypi.org/project/mcp-agent/"><img src="https://img.shields.io/pypi/v/mcp-agent?color=%2334D058&label=pypi" /></a>
19-
<a href="https://github.com/lastmile-ai/mcp-agent/issues"><img src="https://img.shields.io/github/issues-raw/lastmile-ai/mcp-agent" /></a>
2019
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/mcp-agent?label=pypi%20%7C%20downloads"/>
2120
<a href="https://github.com/lastmile-ai/mcp-agent/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg"/></a>
2221
<a href="https://lmai.link/discord/mcp-agent"><img src="https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white" alt="discord"/></a>
@@ -30,25 +29,103 @@
3029

3130
**`mcp-agent`** is a simple, composable framework to build agents using [Model Context Protocol](https://modelcontextprotocol.io/introduction).
3231

33-
**Inspiration**: Anthropic announced 2 foundational updates for AI application developers:
32+
> [!Note]
33+
> mcp-agent's vision is that _MCP is all you need to build agents, and that simple patterns are more robust than complex architectures for shipping high-quality agents_.
34+
35+
`mcp-agent` gives you the following:
36+
37+
1. It fully implements MCP, and handles the pesky business of managing the lifecycle of MCP server connections so you don't have to.
38+
2. It implements every pattern described in Anthropic's [Building Effective Agents](https://www.anthropic.com/engineering/building-effective-agents) in a _composable_ way, allowing you to chain these patterns together.
39+
3. **Durable agents**: It works for simple agents and scales to sophisticated workflows built on [Temporal](https://temporal.io/) so you can pause, resume, and recover without any API changes to your agent.
40+
41+
**Altogether, this is the simplest and easiest way to build robust agent applications**.
42+
43+
We welcome all kinds of [contributions](/CONTRIBUTING.md), feedback and your help in improving this.
44+
45+
## At a glance
46+
47+
<table>
48+
<tr>
49+
<td width="50%" valign="top">
50+
<h3>Build an Agent</h3>
51+
<p>Connect LLMs to MCP servers in simple, composable patterns like map-reduce, orchestrator, evaluator-optimizer, router & more.</p>
52+
<p>
53+
<a href="https://docs.mcp-agent.com/get-started/overview">Quick Start ↗</a> |
54+
<a href="https://docs.mcp-agent.com/mcp-agent-sdk/overview">Docs ↗</a>
55+
</p>
56+
</td>
57+
<td width="50%" valign="top">
58+
<h3>Create any kind of MCP Server</h3>
59+
<p>Create MCP servers with a FastMCP-compatible API. You can even expose agents as MCP servers.</p>
60+
<p>
61+
<a href="https://docs.mcp-agent.com/mcp-agent-sdk/mcp/agent-as-mcp-server">MCP Agent Server ↗</a> |
62+
<a href="https://docs.mcp-agent.com/cloud/use-cases/deploy-chatgpt-apps">🎨 Build a ChatGPT App ↗</a> |
63+
<a href="https://github.com/lastmile-ai/mcp-agent/tree/main/examples/mcp_agent_server">Examples ↗</a>
64+
</p>
65+
</td>
66+
</tr>
67+
<tr>
68+
<td width="50%" valign="top">
69+
<h3>Full MCP Support</h3>
70+
<p><b>Core:</b> Tools ✅ Resources ✅ Prompts ✅ Notifications ✅<br/>
71+
<b>Advanced</b>: OAuth ✅ Sampling ✅ Elicitation ✅ Roots </p>
72+
<p>
73+
<a href="https://github.com/lastmile-ai/mcp-agent/tree/main/examples/mcp">Examples ↗</a> |
74+
<a href="https://modelcontextprotocol.io/docs/getting-started/intro">MCP Docs ↗</a>
75+
</p>
76+
</td>
77+
<td width="50%" valign="top">
78+
<h3>Durable Execution (Temporal)</h3>
79+
<p>Scales to production workloads using Temporal as the agent runtime backend <i>without any API changes</i>.</p>
80+
<p>
81+
<a href="https://docs.mcp-agent.com/mcp-agent-sdk/advanced/durable-agents">Docs ↗</a> |
82+
<a href="https://github.com/lastmile-ai/mcp-agent/tree/main/examples/temporal">Examples ↗</a>
83+
</p>
84+
</td>
85+
</tr>
86+
<tr>
87+
<td width="50%" valign="top">
88+
<h3>☁️ Deploy to Cloud</h3>
89+
<p><b>Beta:</b> Deploy agents yourself, or use `mcp-c` for a managed agent runtime. Agents are exposed as MCP servers.</p>
90+
<p>
91+
<a href="https://docs.mcp-agent.com/get-started/deploy-to-cloud">Cloud Quickstart ↗</a> |
92+
<a href="https://docs.mcp-agent.com/cloud/overview">Docs ↗</a>
93+
</p>
94+
</td>
95+
</tr>
96+
</table>
97+
98+
## Documentation
99+
100+
mcp-agent's complete documentation is available at **[docs.mcp-agent.com](https://docs.mcp-agent.com)**, including full SDK guides, CLI reference, and advanced patterns. This readme gives a high-level overview to get you started.
101+
102+
### Build with LLMs
103+
104+
- [`llms-full.txt`](https://docs.mcp-agent.com/llms-full.txt): contains entire documentation.
105+
- [`llms.txt`](https://docs.mcp-agent.com/llms.txt): sitemap listing key pages in the docs.
106+
- [docs MCP server](https://docs.mcp-agent.com/mcp)
34107

35-
1. [Model Context Protocol](https://www.anthropic.com/news/model-context-protocol) - a standardized interface to let any software be accessible to AI assistants via MCP servers.
36-
2. [Building Effective Agents](https://www.anthropic.com/research/building-effective-agents) - a seminal writeup on simple, composable patterns for building production-ready AI agents.
37-
38-
`mcp-agent` puts these two foundational pieces into an AI application framework:
39-
40-
1. It handles the pesky business of managing the lifecycle of MCP server connections so you don't have to.
41-
2. It implements every pattern described in Building Effective Agents, and does so in a _composable_ way, allowing you to chain these patterns together.
42-
3. **Durable agents**: It works for simple agents and scales to sophisticated workflows built on [Temporal](https://temporal.io/) so you can pause, resume, and recover effortlessly.
43-
44-
Altogether, this is the simplest and easiest way to build robust agent applications. Much like MCP, this project is in early development.
45-
We welcome all kinds of [contributions](/CONTRIBUTING.md), feedback and your help in growing this to become a new standard.
108+
## Get Started
46109

47-
**NEW**: Ready to deploy? Publish your agents as managed MCP servers—see the [Deploy to Cloud guide](https://docs.mcp-agent.com/get-started/deploy-to-cloud).
110+
> [!TIP]
111+
> The CLI is available via `uvx mcp-agent`.
112+
> To get up and running
113+
> Scaffold a project with `uvx mcp-agent init` and deploy with `uvx mcp-agent deploy my-agent`.
114+
>
115+
> You can get up and running in 2 minutes by running these commands:
116+
>
117+
> ```bash
118+
> mkdir hello-mcp-agent && cd hello-mcp-agent
119+
> uvx mcp-agent init
120+
> uv init
121+
> uv add "mcp-agent[openai]"
122+
> # Add openai API key to `mcp_agent.secrets.yaml` or set `OPENAI_API_KEY`
123+
> uv run main.py
124+
> ```
48125
49-
## Get Started
126+
### Installation
50127
51-
We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python projects:
128+
We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python projects (`uv init`).
52129
53130
```bash
54131
uv add "mcp-agent"
@@ -60,8 +137,7 @@ Alternatively:
60137
pip install mcp-agent
61138
```
62139

63-
> [!TIP]
64-
> The CLI is available via `uvx`. Scaffold a project with `uvx mcp-agent init --template basic --dir my-agent` or deploy with `uvx mcp-agent deploy my-agent`.
140+
Also add optional packages for LLM providers (e.g. `mcp-agent[openai, anthropic, google, azure, bedrock]`).
65141

66142
### Quickstart
67143

0 commit comments

Comments
 (0)