Skip to content

Commit 826d94f

Browse files
Cloud docs update, Specifying OpenAI dependency, adding explicit instruction for key (#593)
* minor updates to sequencing of docs * install including openai dependency and adding secret * updating mcp-c docs
1 parent 50f9990 commit 826d94f

File tree

6 files changed

+85
-59
lines changed

6 files changed

+85
-59
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ if __name__ == "__main__":
122122
<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>
123123
<p>
124124
<a href="https://www.youtube.com/watch?v=0C4VY-3IVNU">Demo ↗</a> |
125-
<a href="https://docs.mcp-agent.com/get-started/deploy-to-cloud">Cloud Quickstart ↗</a> |
125+
<a href="https://docs.mcp-agent.com/get-started/cloud">Cloud Quickstart ↗</a> |
126126
<a href="https://docs.mcp-agent.com/cloud/overview">Docs ↗</a>
127127
</p>
128128
</td>
@@ -974,7 +974,8 @@ You can use mcp-agent applications in a standalone fashion (i.e. they aren't par
974974
975975
### How do I deploy to Cloud?
976976
977-
Run `uvx mcp-agent deploy <app-name>` after logging in with `uvx mcp-agent login`. The CLI packages your project, provisions secrets, and exposes an MCP endpoint backed by a durable Temporal runtime. See the [Cloud quickstart](https://docs.mcp-agent.com/get-started/deploy-to-cloud) for step-by-step screenshots and CLI output.
977+
Run `uvx mcp-agent deploy <app-name>` after logging in with `uvx mcp-agent login`. The CLI packages your project, provisions secrets, and exposes an MCP endpoint backed by a durable Temporal runtime. See the [Cloud quickstart](https://docs.mcp-agent.com/get-started/
978+
cloud) for step-by-step screenshots and CLI output.
978979
979980
### Where is the API reference?
980981

docs/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"get-started/welcome",
3636
"get-started/quickstart",
3737
"get-started/install",
38-
"get-started/deploy-to-cloud"
38+
"get-started/cloud"
3939
]
4040
},
4141
{

docs/get-started/deploy-to-cloud.mdx renamed to docs/get-started/cloud.mdx

Lines changed: 66 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,38 @@
11
---
2-
title: Deploy to Cloud
3-
sidebarTitle: "Deploy to Cloud"
4-
description: "Publish your agent to the Cloud with the CLI."
2+
title: "MCP-Cloud (mcp-c)"
3+
sidebarTitle: "Cloud"
4+
description: "Deploy and host your mcp-agents and apps on the cloud."
55
icon: cloud
66
---
77

88
<Info>
99
`mcp-c` is in open beta, and free to use. Share feedback via [GitHub issues](https://github.com/lastmile-ai/mcp-agent/issues) or [Discord](https://lmai.link/discord/mcp-agent).
1010
</Info>
1111

12-
## What is mcp-c?
12+
## What is MCP-Cloud?
1313

14-
Before diving into the workflow, here is the 30‑second summary. See the dedicated pages under [Deployment](/cloud/overview) for full detail:
14+
MCP-Cloud (mcp-c) is a fully managed cloud platform for hosting mcp-agents, apps, and mcp servers.
1515

16-
- **One runtime for any MCP application** – deploy durable `mcp-agent` workflows, FastMCP servers, or ChatGPT App backends. Everything is exposed as an MCP server at `https://<app_id>.deployments.mcp-agent.com` ([Cloud overview](/cloud/mcp-agent-cloud/overview)).
16+
<iframe
17+
src="https://www.youtube.com/embed/0C4VY-3IVNU"
18+
title="mcp-agent cloud overview"
19+
width="100%"
20+
height="420"
21+
frameborder="0"
22+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
23+
allowfullscreen
24+
/>
25+
26+
### Key Benefits
27+
28+
- **One runtime for any MCP application** – deploy durable `mcp-agent` workflows, FastMCP servers, or ChatGPT App backends. Everything is exposed as an MCP server at `https://<unique_id>.deployments.mcp-agent.com` ([Cloud overview](/cloud/mcp-agent-cloud/overview)).
1729
- **Temporal-backed execution** – long-running tools and workflows run on Temporal with retries, pause/resume, and human input support ([Long-running tools](/cloud/mcp-agent-cloud/long-running-tools)).
18-
- **Managed secrets & authentication**classify secrets during deploy, collect user secrets later, and choose bearer or unauthenticated access today (OAuth coming soon) ([Manage secrets](/cloud/mcp-agent-cloud/manage-secrets) and [Deployment auth](/cloud/authentication/deployment-auth)).
30+
- **Managed secrets & authentication**manage secrets for both you, as the developer, and your users. Allow users to specify their own keys, and choose bearer or unauthenticated access today (OAuth coming soon) ([Manage secrets](/cloud/mcp-agent-cloud/manage-secrets) and [Deployment auth](/cloud/authentication/deployment-auth)).
1931
- **Observability built in** – stream logs, forward traces, and inspect workflow history directly from the CLI ([Observability](/cloud/observability)).
2032
- **Easy client install** – use `mcp-agent install` or `mcp-agent cloud configure` to wire the deployed server into Claude Desktop, Cursor, VS Code, or ChatGPT Apps ([Use a deployed server](/cloud/mcp-agent-cloud/use-deployed-server)).
2133

2234
With that context, the steps below show exactly how to deploy.
2335

24-
## TL;DR – three commands
25-
26-
```bash
27-
uvx mcp-agent login
28-
uvx mcp-agent deploy my-agent
29-
uvx mcp-agent cloud servers list
30-
uvx mcp-agent cloud servers describe my-agent
31-
```
32-
33-
1. `login` stores your API token locally.
34-
2. `deploy` packages the current directory and uploads it.
35-
3. `cloud servers list` shows every deployment you have access to.
36-
4. `cloud servers describe` confirms the deployment URL and secret policy.
37-
3836
## 1. Authenticate
3937

4038
```bash
@@ -51,7 +49,7 @@ From the directory containing your `mcp_agent.config.yaml` (or pass `--config-di
5149
uvx mcp-agent deploy my-agent
5250
```
5351

54-
During deployment you'll classify secrets as **deployment** (stored securely) or **user** (provided later via `mcp-agent cloud configure`). Use `--dry-run` to validate without uploading or `--non-interactive` for CI.
52+
During deployment you'll classify secrets as **deployment** (stored securely) or **user** (provided later via `mcp-agent cloud configure`).
5553

5654
<CodeGroup>
5755
```bash basic
@@ -61,14 +59,14 @@ directory/
6159
└── mcp_agent.secrets.yaml
6260
```
6361
```bash deploy
64-
uvx mcp-agent deploy my-agent --dry-run
62+
uvx mcp-agent deploy my-agent
6563
```
6664
</CodeGroup>
6765

6866
After a successful deploy you'll receive an endpoint like:
6967

7068
```
71-
https://<app_id>.deployments.mcp-agent.com
69+
https://<unique_id>.deployments.mcp-agent.com
7270
```
7371

7472
## 3. Connect from clients
@@ -78,13 +76,12 @@ Your cloud deployment is a standard MCP server. Use any MCP client:
7876
<Tabs>
7977
<Tab title="Claude Desktop">
8078
```bash
81-
uvx mcp-agent install https://<app_id>.deployments.mcp-agent.com \
79+
uvx mcp-agent install https://<unique_id>.deployments.mcp-agent.com \
8280
--client claude_desktop \
83-
--name research-buddy \
84-
--dry-run
81+
--name research-buddy
8582
```
8683

87-
Replace `claude_desktop` with `vscode`, `cursor`, `chatgpt` to install in those clients instead.
84+
Replace `claude_desktop` with `vscode`, `cursor`, `chatgpt`, `claude_code` to install in those clients instead.
8885
</Tab>
8986

9087
<Tab title="Python">
@@ -95,7 +92,7 @@ Your cloud deployment is a standard MCP server. Use any MCP client:
9592
servers:
9693
my_agent_cloud:
9794
transport: sse
98-
url: "https://<app_id>.deployments.mcp-agent.com/sse"
95+
url: "https://<unique_id>.deployments.mcp-agent.com/sse"
9996
headers:
10097
Authorization: "Bearer ${MCP_API_KEY}"
10198
```
@@ -142,39 +139,60 @@ Your cloud deployment is a standard MCP server. Use any MCP client:
142139
</Tab>
143140
</Tabs>
144141

145-
## Example: web summarizer workflow
142+
## Example: 👋 Hello World agent
146143

147144
```python main.py
148145
import asyncio
146+
from typing import Optional
147+
149148
from mcp_agent.app import MCPApp
150149
from mcp_agent.agents.agent import Agent
151-
from mcp_agent.executor.workflow import Workflow, WorkflowResult
150+
from mcp_agent.core.context import Context as AppContext
152151
from mcp_agent.workflows.llm.augmented_llm_openai import OpenAIAugmentedLLM
153152

154-
app = MCPApp(name="web_summarizer")
155-
156-
@app.workflow
157-
class WebSummarizerWorkflow(Workflow[str]):
158-
@app.workflow_run
159-
async def run(self, url: str) -> WorkflowResult[str]:
160-
agent = Agent(
161-
name="summarizer",
162-
instruction="Fetch and summarize web content concisely.",
163-
server_names=["fetch"],
153+
# Create the MCPApp, the root of mcp-agent.
154+
app = MCPApp(name="hello_world", description="Hello world mcp-agent application")
155+
156+
# Hello world agent: an Agent using MCP servers + LLM
157+
@app.tool()
158+
async def finder_agent(request: str, app_ctx: Optional[AppContext] = None) -> str:
159+
"""
160+
Run an Agent with access to MCP servers (fetch + filesystem) to handle
161+
the input request.
162+
"""
163+
agent = Agent(
164+
name="finder",
165+
instruction=(
166+
"""You are a helpful assistant. Use MCP servers to fetch and read
167+
files, then answer the request concisely."""
168+
),
169+
server_names=["fetch", "filesystem"],
170+
context=app_ctx,
171+
)
172+
173+
async with agent:
174+
llm = await agent.attach_llm(OpenAIAugmentedLLM)
175+
result = await llm.generate_str(message=request)
176+
return result
177+
178+
async def main():
179+
async with app.run() as agent_app:
180+
# Run the agent
181+
readme_summary = await finder_agent(
182+
request="Please summarize the README.md file in this directory.",
183+
app_ctx=agent_app.context,
164184
)
185+
print(readme_summary)
186+
165187

166-
async with agent:
167-
llm = await agent.attach_llm(OpenAIAugmentedLLM)
168-
summary = await llm.generate_str(
169-
f"Fetch {url} and provide a 3-sentence summary"
170-
)
171-
return WorkflowResult(value=summary)
188+
if __name__ == "__main__":
189+
asyncio.run(main())
172190
```
173191

174192
Deploy with:
175193

176194
```bash
177-
uvx mcp-agent deploy web-summarizer
195+
uvx mcp-agent deploy hello-world
178196
```
179197

180198
## Learn more

docs/get-started/install.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,5 +130,5 @@ mcp-agent includes optional extras for different LLM providers. Install the ones
130130
## Next steps
131131

132132
- [Quickstart](/get-started/quickstart) – create a finder agent and run it locally.
133-
- [Deploy to Cloud](/get-started/deploy-to-cloud) – publish your agent with `uvx mcp-agent deploy`.
133+
- [Deploy to Cloud](/get-started/cloud) – publish your agent with `uvx mcp-agent deploy`.
134134
- [MCP Servers](/mcp-agent-sdk/mcp/overview) – learn how FastMCP and other servers plug into your agents.

docs/get-started/quickstart.mdx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,18 @@ Let's get you set up with a hello world mcp-agent!
2323
```bash
2424
uvx mcp-agent init
2525
uv init
26-
uv add mcp-agent
26+
uv add "mcp-agent[openai]"
2727
uv sync
2828
```
2929
(Prefer pip? `python -m venv .venv && pip install mcp-agent` works too.)
3030
</Step>
31+
<Step title="Add your model provider key">
32+
In the `mcp_agent.secrets.yaml` in your project directory, add your OpenAI or other model provider key.
33+
```yaml mcp_agent.secrets.yaml
34+
openai:
35+
api_key: "your-openai-api-key"
36+
```
37+
</Step>
3138
</Steps>
3239
</Tab>
3340
<Tab title="Do it manually">
@@ -42,7 +49,7 @@ Let's get you set up with a hello world mcp-agent!
4249
<Step title="Install dependencies with uv">
4350
```bash
4451
uv init
45-
uv add mcp-agent
52+
uv add "mcp-agent[openai]"
4653
uv sync
4754
```
4855

@@ -51,7 +58,7 @@ Let's get you set up with a hello world mcp-agent!
5158

5259
<Step title="Add configuration files">
5360
`mcp_agent.config.yaml`
54-
```yaml
61+
```yaml mcp_agent.config.yaml
5562
execution_engine: asyncio
5663
logger:
5764
transports: [console]
@@ -71,15 +78,15 @@ Let's get you set up with a hello world mcp-agent!
7178
```
7279

7380
`mcp_agent.secrets.yaml`
74-
```yaml
81+
```yaml mcp_agent.secrets.yaml
7582
openai:
7683
api_key: "your-openai-api-key"
7784
```
7885
</Step>
7986

8087
<Step title="Paste the hello world agent">
8188
`main.py`
82-
```python
89+
```python main.py
8390
import asyncio
8491
import os
8592
import time
@@ -158,4 +165,4 @@ uvx mcp-agent deploy
158165

159166
- Check out the generated README (if you used the CLI) for tips on extending the agent.
160167
- Layer in more capabilities using the [Effective Patterns](/mcp-agent-sdk/effective-patterns/overview) guide.
161-
- Ready to deploy your agent? Follow [Deploy to Cloud](/get-started/deploy-to-cloud).
168+
- Ready to deploy your agent? Follow [Deploy to Cloud](/get-started/cloud).

docs/get-started/welcome.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ if __name__ == "__main__":
7676
<Card
7777
title="Deploy to the cloud"
7878
icon="cloud"
79-
href="/get-started/deploy-to-cloud"
79+
href="/get-started/cloud"
8080
>
8181
Use `uvx mcp-agent deploy` to host your agent as a managed MCP server.
8282
</Card>

0 commit comments

Comments
 (0)