Skip to content

Commit 9ebaa7b

Browse files
committed
update toc
1 parent fcfdd6c commit 9ebaa7b

File tree

1 file changed

+67
-8
lines changed

1 file changed

+67
-8
lines changed

README.md

Lines changed: 67 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,45 @@
3434
3535
`mcp-agent` gives you the following:
3636

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.
37+
1. **Full MCP support**: 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. **Effective agent patterns**: 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.
3939
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.
4040

41-
**Altogether, this is the simplest and easiest way to build robust agent applications**.
41+
<u>Altogether, this is the simplest and easiest way to build robust agent applications</u>.
4242

43-
We welcome all kinds of [contributions](/CONTRIBUTING.md), feedback and your help in improving this.
43+
We welcome all kinds of [contributions](/CONTRIBUTING.md), feedback and your help in improving this project.
44+
45+
**Minimal example**
46+
47+
```python
48+
import asyncio
49+
50+
from mcp_agent.app import MCPApp
51+
from mcp_agent.agents.agent import Agent
52+
from mcp_agent.workflows.llm.augmented_llm_openai import OpenAIAugmentedLLM
53+
54+
app = MCPApp(name="hello_world")
55+
56+
async def main():
57+
async with app.run():
58+
agent = Agent(
59+
name="finder",
60+
instruction="Use filesystem and fetch to answer questions.",
61+
server_names=["filesystem", "fetch"],
62+
)
63+
async with agent:
64+
llm = await agent.attach_llm(OpenAIAugmentedLLM)
65+
answer = await llm.generate_str("Summarize README.md in two sentences.")
66+
print(answer)
67+
68+
69+
if __name__ == "__main__":
70+
asyncio.run(main())
71+
72+
# Add your LLM API key to `mcp_agent.secrets.yaml` or set it in env.
73+
# The [Getting Started guide](https://docs.mcp-agent.com/get-started/overview) walks through configuration and secrets in detail.
74+
75+
```
4476

4577
## At a glance
4678

@@ -86,25 +118,52 @@ We welcome all kinds of [contributions](/CONTRIBUTING.md), feedback and your hel
86118
<tr>
87119
<td width="50%" valign="top">
88120
<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>
121+
<p><b>Beta:</b> Deploy agents yourself, or use <b>mcp-c</b> for a managed agent runtime. All apps are deployed as MCP servers.</p>
90122
<p>
123+
<a href="https://www.youtube.com/watch?v=0C4VY-3IVNU">Demo ↗</a> |
91124
<a href="https://docs.mcp-agent.com/get-started/deploy-to-cloud">Cloud Quickstart ↗</a> |
92125
<a href="https://docs.mcp-agent.com/cloud/overview">Docs ↗</a>
93126
</p>
94127
</td>
95128
</tr>
96129
</table>
97130

98-
## Documentation
131+
## Documentation & build with LLMs
99132

100133
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.
101134

102-
### Build with LLMs
103-
104135
- [`llms-full.txt`](https://docs.mcp-agent.com/llms-full.txt): contains entire documentation.
105136
- [`llms.txt`](https://docs.mcp-agent.com/llms.txt): sitemap listing key pages in the docs.
106137
- [docs MCP server](https://docs.mcp-agent.com/mcp)
107138

139+
## Table of Contents
140+
141+
- [Overview](#overview)
142+
- [Quickstart](#get-started)
143+
- [Why mcp-agent](#why-use-mcp-agent)
144+
- [Core concepts](#core-concepts)
145+
- [MCPApp](#mcpapp)
146+
- [Agents & AgentSpec](#agents--agentspec)
147+
- [Augmented LLM](#augmented-llm)
148+
- [Workflows & decorators](#workflows--decorators)
149+
- [Configuration & secrets](#configuration--secrets)
150+
- [MCP integration](#mcp-integration)
151+
- [Workflow patterns](#workflow-patterns)
152+
- [Durable execution](#durable-execution)
153+
- [Agent servers](#agent-servers)
154+
- [CLI reference](#cli-reference)
155+
- [Authentication](#authentication)
156+
- [Advanced](#advanced)
157+
- [Observability & controls](#observability--controls)
158+
- [Composing workflows](#composability)
159+
- [Signals & human input](#signaling-and-human-input)
160+
- [App configuration](#app-config)
161+
- [MCP server management](#mcp-server-management)
162+
- [Cloud deployment](#cloud-deployment)
163+
- [Examples](#examples)
164+
- [FAQ](#faq)
165+
- [Community & contributions](#community--contributions)
166+
108167
## Get Started
109168

110169
> [!TIP]

0 commit comments

Comments
 (0)