mirror of
https://github.com/outbackdingo/optimclaw.git
synced 2026-08-25 14:53:34 +00:00
61a123a746
* Add GitHub tool for IronClaw - manage repos, issues, PRs, and workflows * Add Discord channel for IronClaw - slash commands and button interactions * Security fixes: URL encoding, secret validation, Discord button handler - Add URL encoding for all path segments and query parameters (P1) - Add path segment validation to prevent path traversal - Add secret_exists check for better error messages (P2) - Fix http_request signature to use 5 args (P2) - Fix Discord button handler to check member field (P2) - Fix typo in Discord slash command format (P2) - Add github.capabilities.json and discord.capabilities.json (Blocker) - Add Cargo.toml for Discord channel (Blocker) - Add limit caps (max 100) for all list operations (P3) - Remove debug logging * Apply Copilot review fixes Security & Code Quality: - Use secret_get instead of workspace_read for GitHub token - Remove manual Authorization header (host injects via capabilities) - Add validation for file paths (reject path traversal) - Add validation for workflow_id and git refs - Fix url_encode_query comment - Add release profile optimizations to Cargo.toml files - Fix package names to match conventions (github-tool, discord-channel) - Add metadata fields to Cargo.toml - Fix rate limits to be consistent (60/min, 3600/hr) - Fix Discord user_name to filter empty global_name - Fix Discord metadata serialization error handling - Update Discord README to clarify which secrets are used by host vs WASM - Better formatting for Discord command option values * applied all PR change requests and comments * cleaned up workspace * Adding validation for empty path segments and event enum in GitHub tool * addedvalidation for events and vaidation to reject empty file path in github tools and implemented safe UTF-8 trunacating * added codegen units and updated truncating logic also update capabilities.json as requested by copilot review * added codegen units and updated truncating logic also update capabilities.json as requested by copilot review * fixed message trucating and remove url_encode alias, also appled all requested changes from last PR comment --------- Co-authored-by: root <root@cafx> Co-authored-by: Peni <[email protected]> Co-authored-by: Illia Polosukhin <[email protected]> Co-authored-by: firat.sertgoz <[email protected]>
190 lines
3.4 KiB
Markdown
190 lines
3.4 KiB
Markdown
# GitHub Tool for IronClaw
|
|
|
|
WASM tool for GitHub integration - manage repos, issues, PRs, and workflows.
|
|
|
|
## Features
|
|
|
|
- **Repository Info** - Get repo details, list user repos
|
|
- **Issues** - List, create, and get issue details
|
|
- **Pull Requests** - List PRs, get PR details, review files, create reviews
|
|
- **File Content** - Read files from repos
|
|
- **Workflows** - Trigger GitHub Actions, check run status
|
|
|
|
## Setup
|
|
|
|
1. Create a GitHub Personal Access Token at <https://github.com/settings/tokens>
|
|
2. Required scopes: `repo`, `workflow`, `read:org`
|
|
3. Store the token:
|
|
|
|
```
|
|
ironclaw secret set github_token YOUR_TOKEN
|
|
```
|
|
|
|
## Usage Examples
|
|
|
|
### Get Repository Info
|
|
|
|
```json
|
|
{
|
|
"action": "get_repo",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw"
|
|
}
|
|
```
|
|
|
|
### List Open Issues
|
|
|
|
```json
|
|
{
|
|
"action": "list_issues",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"state": "open",
|
|
"limit": 10
|
|
}
|
|
```
|
|
|
|
### Create Issue
|
|
|
|
```json
|
|
{
|
|
"action": "create_issue",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"title": "Bug: Something is broken",
|
|
"body": "Detailed description...",
|
|
"labels": ["bug", "help wanted"]
|
|
}
|
|
```
|
|
|
|
### List Pull Requests
|
|
|
|
```json
|
|
{
|
|
"action": "list_pull_requests",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"state": "open",
|
|
"limit": 5
|
|
}
|
|
```
|
|
|
|
### Review PR
|
|
|
|
```json
|
|
{
|
|
"action": "create_pr_review",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"pr_number": 42,
|
|
"body": "LGTM! Great work.",
|
|
"event": "APPROVE"
|
|
}
|
|
```
|
|
|
|
### Get File Content
|
|
|
|
```json
|
|
{
|
|
"action": "get_file_content",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"path": "README.md",
|
|
"ref": "main"
|
|
}
|
|
```
|
|
|
|
### Trigger Workflow
|
|
|
|
```json
|
|
{
|
|
"action": "trigger_workflow",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"workflow_id": "ci.yml",
|
|
"ref": "main",
|
|
"inputs": {
|
|
"environment": "staging"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Check Workflow Runs
|
|
|
|
```json
|
|
{
|
|
"action": "get_workflow_runs",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"limit": 5
|
|
}
|
|
```
|
|
|
|
### List Workflow Runs (Pagination)
|
|
|
|
```json
|
|
{
|
|
"action": "get_workflow_runs",
|
|
"owner": "nearai",
|
|
"repo": "ironclaw",
|
|
"limit": 5,
|
|
"page": 2
|
|
}
|
|
```
|
|
|
|
## Error Handling
|
|
|
|
Errors are returned as strings in the `error` field of the response.
|
|
|
|
### Rate Limit Exceeded
|
|
|
|
When the GitHub API rate limit is exceeded (and retries fail), you might see:
|
|
|
|
```text
|
|
GitHub API error 429: { "message": "API rate limit exceeded for user ID ...", ... }
|
|
```
|
|
|
|
The tool automatically logs warnings when the rate limit is low (<10 remaining) and retries on 429/5xx errors.
|
|
|
|
### Invalid Parameters
|
|
|
|
```text
|
|
Invalid event: 'INVALID'. Must be one of: APPROVE, REQUEST_CHANGES, COMMENT
|
|
```
|
|
|
|
### Missing Token
|
|
|
|
```text
|
|
GitHub token not found in secret store. Set it with: ironclaw secret set github_token <token>...
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### "GitHub API error 404: Not Found"
|
|
|
|
- Check that the `owner` and `repo` are correct.
|
|
- Ensure the `github_token` has access to the repository (especially for private repos).
|
|
- Verify the token scopes include `repo` and `read:org`.
|
|
|
|
### "GitHub API error 401: Bad credentials"
|
|
|
|
- The token might be invalid or expired.
|
|
- Update the token: `ironclaw secret set github_token NEW_TOKEN`.
|
|
|
|
### Rate Limiting
|
|
|
|
- The tool logs a warning when remaining requests drop below 10.
|
|
- Check logs for "GitHub API rate limit low".
|
|
- If you hit the limit, wait for the reset time (usually 1 hour).
|
|
|
|
## Building
|
|
|
|
```bash
|
|
cd tools-src/github
|
|
cargo build --target wasm32-wasi --release
|
|
```
|
|
|
|
## License
|
|
|
|
MIT/Apache-2.0
|