You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/mcp_agent/data/templates/README_basic.md
+11-46Lines changed: 11 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,10 @@ Welcome! This project was generated by `mcp-agent init`. It’s a minimal, reada
15
15
16
16
## Quick start
17
17
18
-
1. Add your OpenAI API key to `mcp_agent.secrets.yaml` (or set `OPENAI_API_KEY`env var).
18
+
1. Add API keys to `mcp_agent.secrets.yaml` (or set env vars):
19
19
20
-
NOTE: You can use another supported provider (e.g. Anthropic) instead, just be sure to set its API key in the `mcp_agent.secrets.yaml` (or set its env var) and import/use the relevant `AugmentedLLM` in `main.py`.
20
+
-`OPENAI_API_KEY` (recommended)
21
+
-`ANTHROPIC_API_KEY` (optional)
21
22
22
23
2. Review `mcp_agent.config.yaml`:
23
24
@@ -29,7 +30,6 @@ NOTE: You can use another supported provider (e.g. Anthropic) instead, just be s
29
30
3. Run locally:
30
31
31
32
```bash
32
-
uv pip install -r requirements.txt
33
33
uv run main.py
34
34
```
35
35
@@ -38,58 +38,23 @@ You’ll see two summaries printed:
38
38
- A summary of `README.md` from your current directory.
39
39
- A summary of the intro page at modelcontextprotocol.io.
40
40
41
-
4. Run locally as an MCP server:
41
+
4. Deploy a remote MCP server:
42
+
43
+
### Run as an MCP server
42
44
43
45
- In `main.py`, UNCOMMENT the server lines that call `create_mcp_server_for_app(agent_app)` and `run_sse_async()`.
44
46
- Start the server: `uv run main.py`
45
-
- Once you see the server started, e.g.
46
-
```bash
47
-
Uvicorn running on http://127.0.0.1:8000
48
-
```
49
-
you can connect to it with your preferred MCP Client. For example, you can use [MCP Inspector](https://github.com/modelcontextprotocol/inspector) to explore and test the server:
When you're ready to deploy, ensure the required API keys are set in `mcp_agent.secrets.yaml` and then run:
58
-
59
-
```bash
60
-
uv run mcp-agent login
61
-
```
62
-
63
-
to authenticate to mcp-agent cloud. You will be redirected to the login page, create an mcp-agent cloud account through Google or Github.
64
47
65
-
Set up your mcp-agent cloud API Key and copy & paste it into your terminal
48
+
When you're ready to deploy, simply run:
66
49
67
50
```bash
68
-
INFO: Directing to MCP Agent Cloud API login...
69
-
Please enter your API key 🔑:
51
+
mcp-agent deploy "hello_world"
70
52
```
71
53
72
-
In your terminal, deploy the MCP app:
73
-
74
-
```bash
75
-
uv run mcp-agent deploy hello_world
76
-
```
77
-
78
-
You will then be prompted to specify the type of secret to save your OpenAI API key as. Select (1) deployment secret so that it is available to the deployed server.
79
-
80
-
The `deploy` command will bundle the app files and deploy them, wrapping your app as a hosted MCP SSE server with a URL of the form:
81
-
`https://<server_id>.deployments.mcp-agent.com`.
82
-
83
-
Anything decorated with `@app.tool` (or `@app.async_tool`) runs as a Temporal workflow in the cloud.
84
-
85
-
Since the mcp-agent app is exposed as an MCP server, it can be used in any MCP client just
86
-
like any other MCP server. For example, you can inspect and test the server using MCP Inspector:
0 commit comments