Skip to content

Fix/update docs for secrets tags #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 16, 2025
Merged

Fix/update docs for secrets tags #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9884be5
Fix references to secrets tags in docs
rholinshead Sep 16, 2025
783cc82
Merge in main
rholinshead Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/cloud/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ mcp:
openai:
default_model: gpt-4o
```

```yaml mcp_agent.secrets.yaml
openai:
api_key: "sk-..."
```
</CodeGroup>

### Deploy to Cloud
Expand Down
12 changes: 12 additions & 0 deletions docs/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,18 @@ Keep sensitive configuration in separate secrets files:
api_key: "${OPENAI_API_KEY}"
```
</Tab>

<Tab title="Cloud Secrets">
For mcp-agent cloud deployments, only raw secrets (not environment variables) are supported:

```yaml
openai:
api_key: "sk-..."
```

During deployment, you will be prompted to specify which secrets should be used for the deployed app and which
secrets will be excluded (and require a subsequent 'configure' command to configure with user secrets).
</Tab>
</Tabs>

### Subagent Configuration
Expand Down
15 changes: 8 additions & 7 deletions examples/basic/mcp_basic_agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ uv run mcp-agent login
```

### `b.` Deploy your agent with a single command

```bash
uv run mcp-agent deploy my-first-agent
```
Expand Down Expand Up @@ -129,17 +130,17 @@ Configure Claude Desktop to access your agent servers by updating your `~/.claud
Use MCP Inspector to explore and test your agent servers:

```bash
npx @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector
```

Make sure to fill out the following settings:

| Setting | Value |
|---|---|
| *Transport Type* | *SSE* |
| *SSE* | *https://[your-agent-server-id].deployments.mcp-agent.com/sse* |
| *Header Name* | *Authorization* |
| *Bearer Token* | *your-mcp-agent-cloud-api-token* |
| Setting | Value |
| ---------------- | -------------------------------------------------------------- |
| _Transport Type_ | _SSE_ |
| _SSE_ | _https://[your-agent-server-id].deployments.mcp-agent.com/sse_ |
| _Header Name_ | _Authorization_ |
| _Bearer Token_ | _your-mcp-agent-cloud-api-token_ |

> [!TIP]
> In the Configuration, change the request timeout to a longer time period. Since your agents are making LLM calls, it is expected that it should take longer than simple API calls.
15 changes: 8 additions & 7 deletions examples/basic/mcp_model_selector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ uv run mcp-agent login
```

### `b.` Deploy your agent with a single command

```bash
uv run mcp-agent deploy model-selector-server
```
Expand Down Expand Up @@ -105,17 +106,17 @@ Configure Claude Desktop to access your agent servers by updating your `~/.claud
Use MCP Inspector to explore and test your agent servers:

```bash
npx @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector
```

Make sure to fill out the following settings:

| Setting | Value |
|---|---|
| *Transport Type* | *SSE* |
| *SSE* | *https://[your-agent-server-id].deployments.mcp-agent.com/sse* |
| *Header Name* | *Authorization* |
| *Bearer Token* | *your-mcp-agent-cloud-api-token* |
| Setting | Value |
| ---------------- | -------------------------------------------------------------- |
| _Transport Type_ | _SSE_ |
| _SSE_ | _https://[your-agent-server-id].deployments.mcp-agent.com/sse_ |
| _Header Name_ | _Authorization_ |
| _Bearer Token_ | _your-mcp-agent-cloud-api-token_ |

> [!TIP]
> In the Configuration, change the request timeout to a longer time period. Since your agents are making LLM calls, it is expected that it should take longer than simple API calls.
10 changes: 7 additions & 3 deletions examples/mcp_agent_server/asyncio/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,9 @@ uv run client.py --custom-fastmcp-settings
### [Beta] Deploying to mcp-agent cloud

You can deploy your MCP-Agent app as a hosted mcp-agent app in the Cloud.

1. In your terminal, authenticate into mcp-agent cloud by running:

```
uv run mcp-agent login
```
Expand All @@ -167,17 +169,19 @@ uv run mcp-agent login
```
andrew_lm@Mac sdk-cloud % uv run mcp-agent login
INFO: Directing to MCP Agent Cloud API login...
Please enter your API key 🔑:
Please enter your API key 🔑:
```

4. In your terminal, deploy the MCP app:

```
uv run mcp-agent deploy mcp_agent_server -c /absolute/path/to/your/project
```

5. In the terminal, you will then be prompted to specify your OpenAI and/or Anthropic keys:

Once the deployment is successful, you should see the following:

```
andrew_lm@Mac sdk-cloud % uv run mcp-agent deploy basic_agent_server -c /Users/andrew_lm/Documents/GitHub/mcp-agent/examples/mcp_agent_server/asyncio/
╭─────────────────────────────────────────────────── MCP Agent Deployment ────────────────────────────────────────────────────╮
Expand All @@ -189,13 +193,13 @@ INFO: Using API at https://mcp-agent.com/api
INFO: Checking for existing app ID for 'basic_agent_server'...
SUCCESS: Found existing app with ID: app_dd3a033d-4f4b-4e33-b82c-aad9ec43c52f for name 'basic_agent_server'
INFO: Processing secrets file...
INFO: Found existing transformed secrets to use where applicable:
INFO: Found existing transformed secrets to use where applicable:
/Users/andrew_lm/Documents/GitHub/mcp-agent/examples/mcp_agent_server/asyncio/mcp_agent.deployed.secrets.yaml
INFO: Loaded existing secrets configuration for reuse
INFO: Reusing existing developer secret handle at 'openai.api_key': mcpac_sc_83d412fd-083e-4174-89b4-ecebb1e4cae9
INFO: Transformed config written to /Users/andrew_lm/Documents/GitHub/mcp-agent/examples/mcp_agent_server/asyncio/mcp_agent.deployed.secrets.yaml

Secrets Processing Summary
Secrets Processing Summary
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ Type ┃ Path ┃ Handle/Status ┃ Source ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
Expand Down
19 changes: 9 additions & 10 deletions examples/usecases/mcp_github_to_slack_agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,25 +109,25 @@ Configure Claude Desktop to access your agent servers by updating your `~/.claud
Use MCP Inspector to explore and test your agent servers:

```bash
npx @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector
```

Make sure to fill out the following settings:

| Setting | Value |
|---|---|
| *Transport Type* | *SSE* |
| *SSE* | *https://[your-agent-server-id].deployments.mcp-agent.com/sse* |
| *Header Name* | *Authorization* |
| *Bearer Token* | *your-mcp-agent-cloud-api-token* |
| Setting | Value |
| ---------------- | -------------------------------------------------------------- |
| _Transport Type_ | _SSE_ |
| _SSE_ | _https://[your-agent-server-id].deployments.mcp-agent.com/sse_ |
| _Header Name_ | _Authorization_ |
| _Bearer Token_ | _your-mcp-agent-cloud-api-token_ |

> [!TIP]
> In the Configuration, change the request timeout to a longer time period. Since your agents are making LLM calls, it is expected that it should take longer than simple API calls.

##### Trigger Agent Run on Cloud

Once you are connected to the MCP Agent on cloud, you will get a list of tools as follow:

- MCP Agent Cloud Default Tools:
- workflow-list: list the workflow (you don't need this)
- workflow-run-list: list the execution runs of your agent
Expand All @@ -138,8 +138,8 @@ Once you are connected to the MCP Agent on cloud, you will get a list of tools a
- Tool's that your agent expose:
- github_to_slack: default of your tool name, input the parameters to trigger a workflow run


Once you run the agent, successful trigger will return a workflow_run metadata object, where you can find your run id to query status:

```json
{
"workflow_id": "github_to_slack-uuid",
Expand Down Expand Up @@ -182,4 +182,3 @@ When you agent run successfully finishes, you will see Slack message is posted b
}
}
```

14 changes: 8 additions & 6 deletions examples/workflows/workflow_evaluator_optimizer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,12 @@ npx @modelcontextprotocol/inspector

Configure the following settings in MCP Inspector:

| Setting | Value |
|---|---|
| **Transport Type** | SSE |
| **SSE URL** | `https://[your-agent-server-id].deployments.mcp-agent.com/sse` |
| **Header Name** | Authorization |
| **Bearer Token** | your-mcp-agent-cloud-api-token |
| Setting | Value |
| ------------------ | -------------------------------------------------------------- |
| **Transport Type** | SSE |
| **SSE URL** | `https://[your-agent-server-id].deployments.mcp-agent.com/sse` |
| **Header Name** | Authorization |
| **Bearer Token** | your-mcp-agent-cloud-api-token |

> [!TIP]
> Increase the request timeout in the Configuration settings since LLM calls may take longer than simple API calls.
Expand All @@ -156,6 +156,7 @@ Configure the following settings in MCP Inspector:
Once connected to your deployed agent, you'll have access to:

**MCP Agent Cloud Default Tools:**

- `workflow-list`: List available workflows
- `workflow-run-list`: List execution runs of your agent
- `workflow-run`: Create a new workflow run
Expand All @@ -164,6 +165,7 @@ Once connected to your deployed agent, you'll have access to:
- `workflows-cancel`: Cancel a running workflow

**Your Agent's Tool:**

- `cover_letter_writer_tool`: Generate optimized cover letters with parameters:
- `job_posting`: Job description and requirements
- `candidate_details`: Candidate background and qualifications
Expand Down
15 changes: 8 additions & 7 deletions examples/workflows/workflow_intent_classifier/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ uv run mcp-agent login
```

### `b.` Deploy your agent with a single command

```bash
uv run mcp-agent deploy workflow-intent-classifier
```
Expand Down Expand Up @@ -93,17 +94,17 @@ Configure Claude Desktop to access your agent servers by updating your `~/.claud
Use MCP Inspector to explore and test your agent servers:

```bash
npx @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector
```

Make sure to fill out the following settings:

| Setting | Value |
|---|---|
| *Transport Type* | *SSE* |
| *SSE* | *https://[your-agent-server-id].deployments.mcp-agent.com/sse* |
| *Header Name* | *Authorization* |
| *Bearer Token* | *your-mcp-agent-cloud-api-token* |
| Setting | Value |
| ---------------- | -------------------------------------------------------------- |
| _Transport Type_ | _SSE_ |
| _SSE_ | _https://[your-agent-server-id].deployments.mcp-agent.com/sse_ |
| _Header Name_ | _Authorization_ |
| _Bearer Token_ | _your-mcp-agent-cloud-api-token_ |

> [!TIP]
> In the Configuration, change the request timeout to a longer time period. Since your agents are making LLM calls, it is expected that it should take longer than simple API calls.
16 changes: 8 additions & 8 deletions examples/workflows/workflow_orchestrator_worker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ Run your MCP Agent app:
uv run main.py
```


## `4` [Beta] Deploy to the cloud

### `a.` Log in to [MCP Agent Cloud](https://docs.mcp-agent.com/cloud/overview)
Expand All @@ -77,6 +76,7 @@ uv run mcp-agent login
```

### `b.` Deploy your agent with a single command

```bash
uv run mcp-agent deploy workflow-orchestrator-server
```
Expand Down Expand Up @@ -109,17 +109,17 @@ Configure Claude Desktop to access your agent servers by updating your `~/.claud
Use MCP Inspector to explore and test your agent servers:

```bash
npx @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector
```

Make sure to fill out the following settings:

| Setting | Value |
|---|---|
| *Transport Type* | *SSE* |
| *SSE* | *https://[your-agent-server-id].deployments.mcp-agent.com/sse* |
| *Header Name* | *Authorization* |
| *Bearer Token* | *your-mcp-agent-cloud-api-token* |
| Setting | Value |
| ---------------- | -------------------------------------------------------------- |
| _Transport Type_ | _SSE_ |
| _SSE_ | _https://[your-agent-server-id].deployments.mcp-agent.com/sse_ |
| _Header Name_ | _Authorization_ |
| _Bearer Token_ | _your-mcp-agent-cloud-api-token_ |

> [!TIP]
> In the Configuration, change the request timeout to a longer time period. Since your agents are making LLM calls, it is expected that it should take longer than simple API calls.
Loading
Loading