# Tendril Quick Start Guide

**TL;DR**: Get Tendril working in 5 minutes.

## Prerequisites

```bash
# 1. Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# 2. Download and install gitea-mcp binary
wget https://gitea.com/gitea/gitea-mcp/releases/download/v1.0.0/gitea-mcp-linux-amd64
chmod +x gitea-mcp-linux-amd64
sudo mv gitea-mcp-linux-amd64 /usr/local/bin/gitea-mcp

# Verify
/usr/local/bin/gitea-mcp --help
```

## Generate Gitea Token

1. Log in to your Gitea instance
2. Settings → Applications → Authorize New Application
3. Name: "Zed MCP"
4. Check repository permissions
5. Copy the token

## Install in Zed (Dev Extension)

```bash
# 1. Open Zed
# 2. Extensions → Install Dev Extension
# 3. Select the tendril directory
# 4. Wait for Zed to compile (a few seconds first time)
```

## Configure Zed

Add to your `settings.json`:

```json
{
  "context_servers": {
    "tendril-gitea-mcp": {
      "settings": {
        "gitea_access_token": "YOUR_TOKEN_HERE"
      }
    }
  }
}
```

## Test It

1. Open Zed's Assistant (Cmd+K)
2. Type: `list my repositories`
3. Done! 🎉

---

## Configuration Options

```json
{
  "context_servers": {
    "tendril-gitea-mcp": {
      "settings": {
        "gitea_access_token": "required",           // Your token
        "gitea_host": "https://git.example.com",   // Self-hosted Gitea
        "gitea_insecure": false,                    // Self-signed certs
        "gitea_port": 8080,                         // SSE mode port
        "use_sse": false                            // Use SSE instead of STDIO
      }
    }
  }
}
```

## Troubleshooting

| Problem | Solution |
|---------|----------|
| "failed to spawn command" | Make sure `/usr/local/bin/gitea-mcp` exists: `ls -l /usr/local/bin/gitea-mcp` |
| Extension not loading | Check Zed logs: `zed: open log` |
| Auth errors | Verify token and permissions, regenerate if needed |
| SSE mode issues | Try STDIO mode: set `"use_sse": false` |

## Useful Commands

```bash
# Test the binary
/usr/local/bin/gitea-mcp --help

# View logs
tail -f ~/.gitea-mcp/gitea-mcp.log

# Check Zed logs (in Zed)
zed: open log

# Rebuild extension
cargo build --release
```

## Need More Help?

- 📖 See **README.md** for full documentation
- 👨‍💻 See **DEVELOPMENT.md** for development guide
- 🔍 See **PROJECT_STATUS.md** for current status and roadmap
- 📋 See **configuration/installation_instructions.md** for detailed setup

## What Tendril Does

Tendril is a **Zed extension** that connects to a **gitea-mcp server** running on your system.

```
Zed (with Tendril extension)
        ↓
gitea-mcp binary (at /usr/local/bin/gitea-mcp)
        ↓
Gitea Instance (your self-hosted or public Gitea)
```

The extension lets you interact with Gitea repositories, issues, PRs, and more directly from Zed's Assistant panel using natural language.

## Quick Links

- 🏠 Repository: https://git.parkingmeter.info/Mycelium/tendril
- 🔗 Gitea MCP: https://gitea.com/gitea/gitea-mcp
- 📝 Zed Docs: https://zed.dev/docs/extensions
- 🧬 Mycelium Project: https://git.parkingmeter.info/Mycelium