Latte
b275f5c0c2
test / test (push) Has been cancelled
lint / lint (push) Has been cancelled
docker / test (pull_request) Successful in 13s
docker / lint (pull_request) Successful in 2m3s
lint / lint (pull_request) Successful in 16s
test / test (pull_request) Successful in 14s
docker / docker-test (pull_request) Successful in 42s
docker / docker-publish (pull_request) Has been skipped
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# AegisGitea MCP - Documentation
|
|
|
|
AegisGitea MCP is a security-first [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that provides controlled AI access to self-hosted Gitea repositories.
|
|
|
|
## Overview
|
|
|
|
AegisGitea MCP acts as a secure bridge between AI assistants (such as Claude, Claude Code, or Cowork) and your Gitea instance. It exposes read tools and opt-in write tools while enforcing per-user OAuth, repository authorization, policy checks, rate limiting, and tamper-evident audit logging.
|
|
|
|
**Version:** 0.1.0 (Alpha)
|
|
**License:** MIT
|
|
**Requires:** Python 3.10+
|
|
|
|
## Documentation
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Getting Started](getting-started.md) | Installation and first-time setup |
|
|
| [Configuration](configuration.md) | All environment variables and settings |
|
|
| [API Reference](api-reference.md) | HTTP endpoints and MCP tools |
|
|
| [Architecture](architecture.md) | System design and data flow |
|
|
| [Security](security.md) | Authentication, rate limiting, and audit logging |
|
|
| [Deployment](deployment.md) | Docker and production deployment |
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# 1. Clone and install
|
|
git clone <repo-url>
|
|
cd AegisGitea-MCP
|
|
make install-dev
|
|
|
|
# 2. Configure
|
|
cp .env.example .env
|
|
# Edit .env with your Gitea URL and token
|
|
|
|
# 3. Generate an API key
|
|
make generate-key
|
|
|
|
# 4. Run
|
|
make run
|
|
```
|
|
|
|
The server starts at `http://localhost:8080`.
|