138 lines
2.7 KiB
Markdown
138 lines
2.7 KiB
Markdown
|
# Forgejo-MCP Quick Start
|
||
|
|
|
||
|
|
## 30-Second Setup
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd /path/to/mcp-gateway
|
||
|
|
|
||
|
|
# 1. Configure environment
|
||
|
|
echo "FORGEJO_URL=http://10.0.0.25:34577" >> .env
|
||
|
|
echo "FORGEJO_ACCESS_TOKEN=df0555d179c7ce6d11c6605b7ddad0921c3c4c83" >> .env
|
||
|
|
|
||
|
|
# 2. Build and start
|
||
|
|
docker-compose build forgejo-mcp
|
||
|
|
docker-compose up -d forgejo-mcp
|
||
|
|
docker-compose restart gateway
|
||
|
|
|
||
|
|
# 3. Verify
|
||
|
|
sleep 5
|
||
|
|
docker-compose logs forgejo-mcp | head -20
|
||
|
|
```
|
||
|
|
|
||
|
|
Done! ✅
|
||
|
|
|
||
|
|
## Verify It Works
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Check service is running
|
||
|
|
docker-compose ps forgejo-mcp
|
||
|
|
|
||
|
|
# Should see: "Up (healthy)"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Available Tools
|
||
|
|
|
||
|
|
```
|
||
|
|
forgejo_list_repositories # List repos
|
||
|
|
forgejo_get_repository # Get repo details
|
||
|
|
forgejo_create_repository # Create repo
|
||
|
|
forgejo_list_issues # List issues
|
||
|
|
forgejo_create_issue # Create issue
|
||
|
|
forgejo_update_issue # Update issue
|
||
|
|
forgejo_list_pull_requests # List PRs
|
||
|
|
forgejo_create_pull_request # Create PR
|
||
|
|
forgejo_list_branches # List branches
|
||
|
|
forgejo_get_file # Read file
|
||
|
|
forgejo_search_repositories # Search repos
|
||
|
|
forgejo_get_user # Get user info
|
||
|
|
```
|
||
|
|
|
||
|
|
## Use Cases
|
||
|
|
|
||
|
|
### List Your Repositories
|
||
|
|
```
|
||
|
|
Tool: forgejo_list_repositories
|
||
|
|
owner: "your-username"
|
||
|
|
```
|
||
|
|
|
||
|
|
### Create an Issue
|
||
|
|
```
|
||
|
|
Tool: forgejo_create_issue
|
||
|
|
owner: "myorg"
|
||
|
|
repo: "myproject"
|
||
|
|
title: "Bug: Login broken"
|
||
|
|
body: "Login button doesn't work"
|
||
|
|
labels: ["bug", "urgent"]
|
||
|
|
```
|
||
|
|
|
||
|
|
### Get Repository Info
|
||
|
|
```
|
||
|
|
Tool: forgejo_get_repository
|
||
|
|
owner: "myorg"
|
||
|
|
repo: "myproject"
|
||
|
|
```
|
||
|
|
|
||
|
|
### Read a File
|
||
|
|
```
|
||
|
|
Tool: forgejo_get_file
|
||
|
|
owner: "myorg"
|
||
|
|
repo: "infrastructure"
|
||
|
|
path: "terraform/main.tf"
|
||
|
|
ref: "main"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
### Service won't start?
|
||
|
|
```bash
|
||
|
|
docker-compose logs forgejo-mcp
|
||
|
|
```
|
||
|
|
|
||
|
|
### Can't find tools in gateway?
|
||
|
|
```bash
|
||
|
|
docker-compose restart gateway
|
||
|
|
docker-compose logs gateway | grep forgejo
|
||
|
|
```
|
||
|
|
|
||
|
|
### Authentication error?
|
||
|
|
```bash
|
||
|
|
# Test token
|
||
|
|
curl -H "Authorization: token df0555d179c7ce6d11c6605b7ddad0921c3c4c83" \
|
||
|
|
http://10.0.0.25:34577/api/v1/user
|
||
|
|
```
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
| Variable | Value |
|
||
|
|
|----------|-------|
|
||
|
|
| `FORGEJO_URL` | `http://10.0.0.25:34577` |
|
||
|
|
| `FORGEJO_ACCESS_TOKEN` | `df0555d179c7ce6d11c6605b7ddad0921c3c4c83` |
|
||
|
|
| Service Port | `8400` |
|
||
|
|
| Network | `mcpnet` |
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
- **README.md** - Full feature documentation
|
||
|
|
- **FORGEJO_SETUP.md** - Detailed setup guide
|
||
|
|
- **INTEGRATION_GUIDE.md** - Architecture & integration details
|
||
|
|
|
||
|
|
## What You Get
|
||
|
|
|
||
|
|
✅ 12 production-ready tools
|
||
|
|
✅ Full async API client
|
||
|
|
✅ Comprehensive error handling
|
||
|
|
✅ Input validation
|
||
|
|
✅ Health checks
|
||
|
|
✅ Docker integration
|
||
|
|
✅ Gateway integration
|
||
|
|
✅ Complete documentation
|
||
|
|
|
||
|
|
## Next Steps
|
||
|
|
|
||
|
|
1. Run the 30-second setup above
|
||
|
|
2. Check the logs to confirm it started
|
||
|
|
3. Try using a tool through Claude
|
||
|
|
4. Explore the available tools
|
||
|
|
|
||
|
|
Enjoy! 🚀
|