Skip to content

Commit 138b70b

Browse files
authored
Update README.md
1 parent bbd1969 commit 138b70b

File tree

1 file changed

+1
-34
lines changed

1 file changed

+1
-34
lines changed

README.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# cagent GitHub Action
22

3-
A GitHub Action for running [CAgent](https://github.com/docker/cagent) AI agents in your workflows. This action simplifies the setup and execution of CAgent, handling binary downloads and environment configuration automatically.
4-
5-
## Features
6-
7-
- 🚀 Single-line agent execution
8-
- 📦 Automatic download of cagent and mcp-gateway binaries
9-
- 🔧 Configurable versions for both dependencies
10-
- 🎯 Built-in support for common agent patterns
11-
- 🔐 Secure secret handling
3+
A GitHub Action for running [cagent](https://github.com/docker/cagent) AI agents in your workflows. This action simplifies the setup and execution of CAgent, handling binary downloads and environment configuration automatically.
124

135
## Usage
146

@@ -189,30 +181,6 @@ jobs:
189181
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
190182
```
191183

192-
## Troubleshooting
193-
194-
### Missing API Key
195-
196-
If you see an error about missing API keys:
197-
1. Go to your repository Settings → Secrets and variables → Actions
198-
2. Add the appropriate secret for your AI provider:
199-
- `ANTHROPIC_API_KEY` for Claude models
200-
- `OPENAI_API_KEY` for GPT models
201-
- `GOOGLE_API_KEY` for Gemini models
202-
203-
### Permission Denied
204-
205-
If the agent cannot comment on PRs:
206-
1. Check that your workflow has `pull-requests: write` permission
207-
2. Ensure `GITHUB_TOKEN` has appropriate scopes
208-
209-
### Binary Download Failures
210-
211-
If binary downloads fail:
212-
- Check your network connectivity
213-
- Verify the specified versions exist in the releases
214-
- Try using different versions with `cagent-version` and `mcp-gateway-version` inputs
215-
216184
## Contributing
217185

218186
Contributions are welcome! Please open an issue or pull request on [GitHub](https://github.com/docker/cagent-action).
@@ -225,4 +193,3 @@ MIT License - see LICENSE file for details.
225193

226194
- [CAgent Repository](https://github.com/docker/cagent)
227195
- [MCP Gateway Repository](https://github.com/docker/mcp-gateway)
228-
- [Documentation](https://github.com/docker/cagent-action)

0 commit comments

Comments
 (0)