Gitea-MCP/AGENTS.md at main

mirror of https://gitea.com/gitea/gitea-mcp.git synced 2026-08-02 15:01:40 +00:00

Files

T

Lunny Xiao 18fcd663e0 docs: rewrite the tool tables and slim down the READMEs (#215 )

Fixes https://gitea.com/gitea/gitea-mcp/issues/214.

The tool tables listed tools that had not existed for several releases. They are regenerated from the registry, gain an `Access` column so it is visible what disappears under `-r` / `GITEA_READONLY`, and get their fine-grained scopes back. `TestReadmeToolTables` now compares them against the registry in both directions, for every translation.

Other corrections from verifying the prose against the source: the pagination parameter is `per_page`, not `perPage`; Go 1.26 is required, not 1.24; the Chinese READMEs were missing the OpenCode and Mistral Vibe sections.

Also trimmed the drifted table of contents and the sections the intro and `gitea-mcp --help` already cover, and dropped the heading emoji. `CLAUDE.md` had its own stale tool list, so it now points at `AGENTS.md` like gitea/gitea does.

---------

Co-authored-by: silverwind <me@silverwind.io>
Reviewed-on: https://gitea.com/gitea/gitea-mcp/pulls/215
Reviewed-by: silverwind <2021+silverwind@noreply.gitea.com>

2026-07-23 17:08:19 +00:00

1.0 KiB

Raw Permalink Blame History

Use make help to find available development targets
Run make fmt to format .go files, and run make lint-go to lint them
Run make tidy after any go.mod changes
Run single go tests with go test -run '^TestName$' ./modulepath/
Ensure no trailing whitespace in edited files
Use Conventional Commits for commit messages and PR titles, e.g. type(scope): subject; ! before the colon if breaking. Use test type for test-only changes.
Never force-push, amend, or squash unless asked. Use new commits and normal push for pull request updates
Preserve existing code comments, do not remove or rewrite comments that are still relevant
Keep comments short, prefer same-line, explain why, never narrate code
Register new tools with Tool.RegisterRead or Tool.RegisterWrite, and add them to the tool tables in README.md, README.zh-cn.md and README.zh-tw.md
Include authorship attribution in issue and pull request comments
Add Co-Authored-By lines to all commits, indicating name and model used

1.0 KiB Raw Permalink Blame History

1.0 KiB

Raw Permalink Blame History