8c84d76bd5
Adds docs/raw-api.md (two-layer policy, sensitive denylist, env vars, write-mode warning), links it from index and api-reference, documents RAW_API_ENABLED / RAW_API_ALLOW_SENSITIVE in .env.example, and adds commented virtual-tool-name deny examples to policy.yaml. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1.4 KiB
1.4 KiB
AegisGitea MCP - Documentation
AegisGitea MCP is a security-first Model Context Protocol (MCP) 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 | Installation and first-time setup |
| Configuration | All environment variables and settings |
| API Reference | HTTP endpoints and MCP tools |
| Raw API Dispatch | The generic gitea_request escape-hatch tool |
| Architecture | System design and data flow |
| Security | Authentication, rate limiting, and audit logging |
| Deployment | Docker and production deployment |
Quick Start
# 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.