3.3 KiB
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Development Commands
Build: make build - Build the gitea-mcp binary
Install: make install - Build and install to GOPATH/bin
Clean: make clean - Remove build artifacts
Test: go test ./... - Run all tests
Hot reload: make dev - Start development server with hot reload (requires air)
Dependencies: make vendor - Tidy and verify module dependencies
Architecture Overview
This is a Gitea MCP (Model Context Protocol) Server written in Go that provides MCP tools for interacting with Gitea repositories, issues, pull requests, users, and more.
Core Components:
main.go+cmd/cmd.go: CLI entry point and flag parsingoperation/operation.go: Main server setup and tool registrationpkg/tool/tool.go: Tool registry with read/write categorizationoperation/*/: Individual tool modules (user, repo, issue, pull, search, wiki, etc.)
Transport Modes:
- stdio (default): Standard input/output for MCP clients
- http: HTTP server mode on configurable port (default 8080)
Authentication:
- Global token via
--tokenflag orGITEA_ACCESS_TOKENenv var - HTTP mode supports per-request Bearer token override in Authorization header
- Token precedence: HTTP Authorization header > CLI flag > environment variable
Tool Organization:
- Tools are categorized as read-only or write operations
--read-onlyflag exposes only read tools- Tool modules register via
Tool.RegisterRead()andTool.RegisterWrite()
Key Configuration:
- Default Gitea host:
https://gitea.com(override with--hostorGITEA_HOST) - Environment variables can override CLI flags:
MCP_MODE,GITEA_READONLY,GITEA_DEBUG,GITEA_INSECURE - Logs are written to
~/.gitea-mcp/gitea-mcp.logwith rotation
Available Tools
The server provides 45 MCP tools covering:
- User: get_me, get_user_orgs
- Search: search_users, search_repos, search_org_teams
- Repository: create_repo, fork_repo, list_my_repos
- Branches: list_branches, create_branch, delete_branch
- Tags: list_tags, get_tag, create_tag, delete_tag
- Files: get_file_contents, get_dir_contents, create_or_update_file, delete_file
- Commits: list_commits
- Issues: list_issues, issue_read, issue_write
- Pull Requests: list_pull_requests, pull_request_read, pull_request_write, pull_request_review_write
- Labels: label_read, label_write
- Milestones: milestone_read, milestone_write
- Releases: list_releases, get_release, get_latest_release, create_release, delete_release
- Wiki: wiki_read, wiki_write
- Time Tracking: timetracking_read, timetracking_write
- Actions Runs: actions_run_read, actions_run_write
- Actions Config: actions_config_read, actions_config_write
- Version: get_gitea_mcp_server_version
Common Development Patterns
Testing: Use go test ./operation -run TestFunctionName for specific tests
Token Context: HTTP requests use pkg/context.TokenContextKey for request-scoped token access
Flag Access: All packages access configuration via global variables in pkg/flag/flag.go
Graceful Shutdown: HTTP mode implements graceful shutdown with 10-second timeout on SIGTERM/SIGINT