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
+46-11Lines changed: 46 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,10 @@ Welcome! This project was generated by `mcp-agent init`. It’s a minimal, reada
17
17
18
18
1. Add API keys to `mcp_agent.secrets.yaml` (or set env vars):
19
19
20
-
-`OPENAI_API_KEY` (recommended)
21
-
-`ANTHROPIC_API_KEY` (optional)
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`.
21
+
22
+
-`OPENAI_API_KEY` (recommended)
23
+
-`ANTHROPIC_API_KEY` (optional)
22
24
23
25
2. Review `mcp_agent.config.yaml`:
24
26
@@ -38,23 +40,56 @@ You’ll see two summaries printed:
38
40
- A summary of `README.md` from your current directory.
39
41
- A summary of the intro page at modelcontextprotocol.io.
40
42
41
-
4. Deploy a remote MCP server:
42
-
43
-
### Run as an MCP server
43
+
4. Run locally as an MCP server:
44
44
45
45
- In `main.py`, UNCOMMENT the server lines that call `create_mcp_server_for_app(agent_app)` and `run_sse_async()`.
46
-
- Start the server: `uv run main.py`
47
46
48
-
When you're ready to deploy, simply run:
47
+
- Once you see the server started, e.g.
48
+
```bash
49
+
Uvicorn running on http://127.0.0.1:8000
50
+
```
51
+
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:
0 commit comments