From 1a267d79641faf31da5c92ddac1af16f5e17ab56 Mon Sep 17 00:00:00 2001 From: Defame1297 Date: Sun, 5 Jul 2026 11:00:51 +0000 Subject: [PATCH] feat(gitea): add gitea-prs skill Covers list_pull_requests, pull_request_read, pull_request_write, and pull_request_review_write, split out of the flat plugins/bin/skills/gitea PR-dispatch logic per ADR 0011. Composes gitea-labels-milestones for label/milestone ID resolution instead of duplicating that lookup. Tool signatures were cross-checked live via ToolSearch against the deployed gitea-mcp server rather than copied from api-reference.md, per the ADR's schema-drift mitigation process. --- plugins/gitea/skills/gitea-prs/README.md | 25 +++++++ plugins/gitea/skills/gitea-prs/SKILL.md | 68 +++++++++++++++++ .../skills/gitea-prs/references/merging.md | 41 ++++++++++ .../gitea-prs/references/pull-requests.md | 75 +++++++++++++++++++ .../skills/gitea-prs/references/reviews.md | 41 ++++++++++ .../skills/gitea-prs/references/sources.md | 33 ++++++++ 6 files changed, 283 insertions(+) create mode 100644 plugins/gitea/skills/gitea-prs/README.md create mode 100644 plugins/gitea/skills/gitea-prs/SKILL.md create mode 100644 plugins/gitea/skills/gitea-prs/references/merging.md create mode 100644 plugins/gitea/skills/gitea-prs/references/pull-requests.md create mode 100644 plugins/gitea/skills/gitea-prs/references/reviews.md create mode 100644 plugins/gitea/skills/gitea-prs/references/sources.md diff --git a/plugins/gitea/skills/gitea-prs/README.md b/plugins/gitea/skills/gitea-prs/README.md new file mode 100644 index 0000000..3f6841e --- /dev/null +++ b/plugins/gitea/skills/gitea-prs/README.md @@ -0,0 +1,25 @@ +# gitea-prs + +List, read, create, update, merge, and review Gitea pull requests. + +## What it does + +This skill handles the pull request lifecycle within the Gitea integration suite — listing and reading PRs (details, diff, changed files, CI status, reviews), creating and updating them (title, body, reviewers, labels, milestone), closing/reopening, merging with a chosen strategy and post-merge branch cleanup, and the full code-review flow (create a review with inline comments, submit it, dismiss or delete it). It composes `gitea-labels-milestones` for label/milestone ID resolution rather than duplicating that logic, and defers to `gitea-issues` for anything that turns out to be an issue rather than a PR (they share one number space) and to `gitea-branches`/`gitea-files` for the underlying branch/file operations behind a PR. + +## Usage + +``` +/gitea-prs +``` + +Describe the PR or review task: list PRs, get a PR's status/diff/reviews, create or update a PR, merge one, or create/submit/dismiss a code review. The skill will determine owner/repo from context and resolve any label or milestone names via `gitea-labels-milestones` before writing them. + +## Files + +| File | Purpose | +|------|---------| +| `SKILL.md` | Skill instructions for agents — Gotchas, composition with `gitea-labels-milestones`, and the dispatch table | +| `references/pull-requests.md` | Execution detail for `list_pull_requests`, `pull_request_read` (get/get_diff/get_files/get_status), and `pull_request_write` (create/update/close/reopen/update_branch/add_reviewers/remove_reviewers) | +| `references/reviews.md` | Execution detail for `pull_request_review_write` (create/submit/delete/dismiss) and the review-related `pull_request_read` methods | +| `references/merging.md` | The merge workflow — CI vs. review/branch-protection gates, merge styles, branch cleanup, and the post-merge issue-close check | +| `references/sources.md` | Research sources backing the PR/review guidance | diff --git a/plugins/gitea/skills/gitea-prs/SKILL.md b/plugins/gitea/skills/gitea-prs/SKILL.md new file mode 100644 index 0000000..dd3b0a3 --- /dev/null +++ b/plugins/gitea/skills/gitea-prs/SKILL.md @@ -0,0 +1,68 @@ +--- +name: gitea-prs + +description: > + Use when listing, reading, creating, updating, merging, or reviewing Gitea pull requests — + getting PR status/diff/changed files/CI status, opening a PR, updating title/body/reviewers, + closing/reopening, merging with a chosen strategy, or submitting/dismissing a code review with + inline comments. Composes `gitea-labels-milestones` to resolve label names or milestone titles + to the numeric IDs `pull_request_write` requires, rather than duplicating that resolution logic. + Do not use for issues (`gitea-issues`) or branch/commit operations (`gitea-branches`) — a number + the user mentions may refer to either an issue or a PR since they share one number space, so + confirm which domain applies before dispatching. + +compatibility: Requires Gitea MCP server configured with write:issue and write:repository token scopes. + +metadata: + category: integration + source_keys: + - gitea-mcp-repo + - gitea-mcp-slim-go + - context7-websites-gitea + - context7-gitea-tea-cli + version: "0.1.0" + +allowed-tools: mcp__gitea__list_pull_requests mcp__gitea__pull_request_read mcp__gitea__pull_request_write mcp__gitea__pull_request_review_write +--- + +## Gotchas + +- **Issues and PRs share one number space.** A number the user mentions (`#42`) might be an issue, not a PR — there is only one counter per repo. If you're not certain, call `pull_request_read method: "get"` and treat a 404 as "this number is an issue, not a PR" (or check `is_pull` on an `issue_read` response first if you already have one). +- **`pull_request_read method: "get"` returns `review_scomments`, not `review_comments`.** Source-level typo in gitea-mcp v1.3.0. Never reference `review_comments` — it will always be undefined. +- **`draft: true` on create prepends `"WIP:"` to the title.** There is no first-class draft field — Gitea implements draft PRs via title prefix. To un-draft, call `update` and pass the title without the `WIP:` prefix. +- **Cross-repo fork PRs require `head` as `"fork-owner:branch-name"`.** A bare branch name causes Gitea to search the base repo for it and return 422. Same-repo PRs use a bare branch name. +- **PR `milestone` is a bare title string, not `{id, title}`.** Unlike issues, you cannot recover a milestone's ID from a PR response. If you need the ID (e.g. to filter or to pass to another write), call into `gitea-labels-milestones` and match by title via `milestone_read method: "list"`. +- **CI status and review/approval state are independent merge gates.** `get_status` only reports CI. Branch-protection rules (required approvals, requested-reviewer coverage, stale-approval handling) are enforced server-side by the merge call itself and will error if unmet — passing CI does not mean the merge will succeed. +- **Reviews move through a state machine, not a single write.** `create` opens a review in `PENDING` state with inline comments attached; `submit` finalizes it with a terminal `state` (`APPROVED`/`REQUEST_CHANGES`/`COMMENT`). A submitted review can be `dismiss`ed afterward, but never deleted — `delete` only removes a review that was never submitted. +- **Merging a PR does not auto-close linked issues.** Unlike GitHub, Gitea has no merge-triggers-close event. It does parse closing keywords (`Fixes #N`, `Closes #N`) in commit messages landing on the default branch, so a non-squash merge that preserves those commit messages may auto-close the issue — but a squash merge rewrites history into one commit, so survival of the keyword depends on the squash commit's message. Always call `issue_read method: "get"` on any referenced issue after merging to check whether it already closed before deciding to close it explicitly. + +## Composing `gitea-labels-milestones` + +Before any `pull_request_write` call that includes a `labels` or `milestone` parameter, resolve names/titles to numeric IDs via `gitea-labels-milestones` — `label_read method: "list_repo_labels"` for label name → ID, `milestone_read method: "list"` for milestone title → ID. Never pass a label name string or milestone title string directly to `pull_request_write`; both parameters take numeric IDs only. This skill does not duplicate that lookup logic — it composes the shared skill. + +## Dispatch + +| Task | Tool | method | +|---|---|---| +| List PRs | `list_pull_requests` | — | +| Get PR details | `pull_request_read` | `"get"` | +| Get PR diff | `pull_request_read` | `"get_diff"` | +| Get PR changed files | `pull_request_read` | `"get_files"` | +| Get PR CI status | `pull_request_read` | `"get_status"` | +| Get PR reviews | `pull_request_read` | `"get_reviews"` | +| Get one review | `pull_request_read` | `"get_review"` | +| Get review inline comments | `pull_request_read` | `"get_review_comments"` | +| Create a PR | `pull_request_write` | `"create"` | +| Update a PR | `pull_request_write` | `"update"` | +| Close a PR | `pull_request_write` | `"close"` | +| Reopen a PR | `pull_request_write` | `"reopen"` | +| Merge a PR | `pull_request_write` | `"merge"` | +| Update branch from base | `pull_request_write` | `"update_branch"` | +| Add reviewers | `pull_request_write` | `"add_reviewers"` | +| Remove reviewers | `pull_request_write` | `"remove_reviewers"` | +| Create a review | `pull_request_review_write` | `"create"` | +| Submit a review | `pull_request_review_write` | `"submit"` | +| Delete a review | `pull_request_review_write` | `"delete"` | +| Dismiss a review | `pull_request_review_write` | `"dismiss"` | + +For full parameter detail on listing/reading/creating/updating/closing PRs, read `references/pull-requests.md`. For review-specific detail (create/submit/delete/dismiss, inline comment shape), read `references/reviews.md`. For the merge workflow specifically (CI gate, merge styles, branch cleanup, post-merge issue check), read `references/merging.md`. diff --git a/plugins/gitea/skills/gitea-prs/references/merging.md b/plugins/gitea/skills/gitea-prs/references/merging.md new file mode 100644 index 0000000..2be8d06 --- /dev/null +++ b/plugins/gitea/skills/gitea-prs/references/merging.md @@ -0,0 +1,41 @@ +--- +topic: merging +source_keys: + - gitea-mcp-repo + - context7-websites-gitea + - context7-gitea-tea-cli +--- + +# Merge workflow + +## Two independent gates + +Before merging, two things can each independently block the merge, and only one of them is visible from `get_status`: + +1. **CI status** — `pull_request_read method: "get_status"` returns the combined commit status for the PR's head commit. This reflects CI/build checks only. +2. **Review and branch-protection state** — required approval counts, an allowlist of required approvers/teams, whether requested reviewers have reviewed, and stale-approval handling (an approval given before new commits were pushed may be auto-dismissed or ignored, depending on repo settings). None of this is exposed via `get_status` — it is enforced server-side by the merge call itself, and repository admins are not exempt from it by default (an explicit "administrators must follow branch protection" setting is what removes that bypass). + +A green `get_status` does not mean the merge will succeed. Treat both gates as independently checkable, and expect `pull_request_write method: "merge"` to return an error if branch-protection requirements aren't met even when CI is passing. + +## `pull_request_write method: "merge"` + +**Parameters** (in addition to `owner`, `repo`, `pull_number` — see `references/pull-requests.md` for the full parameter list): +- `merge_style` (string, optional, default `"merge"`) — `"merge"` | `"rebase"` | `"rebase-merge"` | `"squash"` | `"fast-forward-only"` +- `title` (string, optional) — override the merge/squash commit's title +- `message` (string, optional) — merge commit message (for squash, this becomes the squash commit's message — see the auto-close gotcha below) +- `delete_branch` (boolean, optional) — delete the head branch after a successful merge +- `force_merge` (boolean, optional) — merge even if checks are failing; use only when the user explicitly asks to override a failing CI status +- `merge_when_checks_succeed` (boolean, optional) — queue the merge to happen automatically once checks pass, instead of merging immediately +- `head_commit_id` (string, optional) — expected head SHA; supplying it lets the server detect if the branch moved since you last read it (conflict detection) rather than merging a stale diff + +## Recommended sequence + +1. Call `pull_request_read method: "get_status"` first. Report CI status to the user. Do not block the merge attempt solely because CI is failing unless the user asks you to stop — but do surface it before proceeding. +2. Call `pull_request_write method: "merge"` with the chosen `merge_style` (ask the user if unspecified; do not default to squash silently, since squash has the closing-keyword implication below) and `delete_branch: true` unless told otherwise. +3. If branch-protection requirements block the merge, the call itself will return the error — report it verbatim rather than retrying with `force_merge` unless the user explicitly asks to override. + +## Merging does not auto-close linked issues + +Gitea has no GitHub-style "merge triggers close" event. It does parse closing keywords (`Fixes #N`, `Closes #N`) in commit messages that land on the default branch — so a regular (non-squash) merge, which preserves each original commit message, can auto-close an issue this way if one of those commits used a closing keyword. A squash merge rewrites history into a single commit, so whether the keyword survives depends entirely on what `message` (or the default squash message) ends up being. + +After any merge, call `issue_read method: "get"` (in `gitea-issues`) on any issue the PR references before deciding whether to close it explicitly. Closing an already-closed issue is a harmless no-op, but don't assume a manual close is always needed, and don't assume it never is. diff --git a/plugins/gitea/skills/gitea-prs/references/pull-requests.md b/plugins/gitea/skills/gitea-prs/references/pull-requests.md new file mode 100644 index 0000000..58fbdf8 --- /dev/null +++ b/plugins/gitea/skills/gitea-prs/references/pull-requests.md @@ -0,0 +1,75 @@ +--- +topic: pull-requests +source_keys: + - gitea-mcp-repo + - gitea-mcp-slim-go +--- + +# Pull request read/write execution detail + +Parameter signatures below are cross-checked live against the deployed gitea-mcp server tool schemas at authoring time — not copied verbatim from the plugin's research doc for this domain, which has a known history of drifting from the deployed server (e.g. a prior `type` parameter that no longer exists on `list_issues`, and the `review_scomments` typo covered in `references/reviews.md`). Re-verify via `ToolSearch` before trusting this file if the gitea-mcp version changes. + +## `list_pull_requests` + +**Parameters:** +- `owner` (string, required) +- `repo` (string, required) +- `state` (string, optional, default `"all"`) — `"open"` | `"closed"` | `"all"` +- `sort` (string, optional, default `"recentupdate"`) — `"oldest"` | `"recentupdate"` | `"leastupdate"` | `"mostcomment"` | `"leastcomment"` | `"priority"` +- `milestone` (number, optional) — milestone ID filter, not a title +- `page` (number, optional, default 1) +- `per_page` (number, optional, default 30) + +List responses trim PRs down to summary fields — `head`/`base` are bare ref strings and `milestone` does not appear as an object. Don't rely on this call to resolve a milestone's ID; see the Gotcha below. + +## `pull_request_read` + +**Parameters:** +- `method` (string, required) — `"get"` | `"get_diff"` | `"get_files"` | `"get_status"` | `"get_reviews"` | `"get_review"` | `"get_review_comments"` +- `owner` (string, required) +- `repo` (string, required) +- `pull_number` (number, required) +- `review_id` (number, optional) — required for `"get_review"` and `"get_review_comments"`; see `references/reviews.md` +- `binary` (boolean, optional) — include binary diff content for `"get_diff"` +- `page` (number, optional, default 1) +- `per_page` (number, optional, default 30) + +`"get"`, `"get_diff"`, `"get_files"`, and `"get_status"` are covered here. `"get_reviews"`, `"get_review"`, and `"get_review_comments"` are covered in `references/reviews.md`. + +- `"get"` returns the full PR object: state, draft, merged, mergeable flags; `head`/`base` as full objects (`{ref, sha, repo?}`); `milestone` as a bare title string (not `{id, title}`); `review_scomments` (typo, see `references/reviews.md`). +- `"get_diff"` returns raw diff text. +- `"get_files"` returns the list of changed file objects. +- `"get_status"` returns the combined commit status for the PR's head commit — CI result only, not review/approval state (see `references/merging.md`). + +**Milestone gotcha:** because `pull_request_read` only ever returns a milestone title, never an ID, resolving "which milestone ID does this PR belong to" requires calling into `gitea-labels-milestones`' `milestone_read method: "list"` and matching by title. Do not attempt to infer or guess the ID. + +## `pull_request_write` + +**Parameters:** +- `method` (string, required) — `"create"` | `"update"` | `"close"` | `"reopen"` | `"merge"` | `"update_branch"` | `"add_reviewers"` | `"remove_reviewers"` +- `owner` (string, required) +- `repo` (string, required) +- `pull_number` (number, required for every method except `"create"` — this is enforced by convention, not by the tool's schema, so passing it incorrectly produces a runtime error rather than a client-side validation error) +- `title` (string, required for `"create"`; optional for `"update"`) +- `body` (string, required for `"create"`; optional for `"update"`) +- `head` (string, required for `"create"`) — source branch; same-repo PRs use a bare branch name, cross-repo fork PRs use `"fork-owner:branch-name"` (see Gotcha) +- `base` (string, required for `"create"`) — target branch +- `assignee` (string, optional) — single login +- `assignees` (array of strings, optional) — login names +- `milestone` (number, optional, for `"update"`) — milestone ID, never a title +- `state` (string, optional, for `"update"`) — `"open"` | `"closed"` (no `"all"` — unlike issue state filters) +- `allow_maintainer_edit` (boolean, optional, for `"update"`) +- `labels` (array of numbers, optional) — label IDs, never names — resolve via `gitea-labels-milestones` first +- `deadline` (string, optional) — ISO 8601 +- `remove_deadline` (boolean, optional) +- `reviewers` (array of strings, optional, for `"add_reviewers"`/`"remove_reviewers"`) — login names +- `team_reviewers` (array of strings, optional, for `"add_reviewers"`/`"remove_reviewers"`) +- `draft` (boolean, optional, for `"create"`) — prepends `"WIP:"` to the title (see Gotcha) + +Merge-specific parameters (`merge_style`, `delete_branch`, `force_merge`, `merge_when_checks_succeed`, `head_commit_id`, `message` as merge commit message) are covered in `references/merging.md`. + +**Cross-repo head format:** `head` must be `"fork-owner:branch-name"` for a PR originating from a fork of the base repo. Passing a bare branch name causes Gitea to search for that branch in the base repo instead, and returns 422 when it isn't found there. + +**Draft/WIP behavior:** `draft: true` on `"create"` is implemented by prepending `"WIP:"` to the title — there is no first-class draft boolean stored separately from the title. The title returned by subsequent reads will include the prefix. To un-draft, call `"update"` with `title` set to the same text minus the `"WIP:"` prefix; there is no dedicated undraft method. + +**`update_branch`:** takes only `owner`, `repo`, `pull_number` — no other parameters. It merges the current base branch into the PR's head branch server-side, resolving a PR that Gitea reports as behind its base (analogous to GitHub's "Update branch" button). Use it when a PR shows `mergeable: false` or an out-of-date status due to base-branch drift rather than an actual conflict; if the head and base have truly diverged with conflicting changes, this call fails and the conflict must be resolved by pushing a merge/rebase to the head branch directly, outside this skill's scope. diff --git a/plugins/gitea/skills/gitea-prs/references/reviews.md b/plugins/gitea/skills/gitea-prs/references/reviews.md new file mode 100644 index 0000000..3fbe953 --- /dev/null +++ b/plugins/gitea/skills/gitea-prs/references/reviews.md @@ -0,0 +1,41 @@ +--- +topic: reviews +source_keys: + - gitea-mcp-repo + - gitea-mcp-slim-go +--- + +# PR review execution detail + +Parameter signatures below are cross-checked live against the deployed gitea-mcp server tool schema, not copied from the plugin's research doc verbatim — same sourcing discipline as `references/pull-requests.md`. + +## Review state machine + +A review is not a single write. It moves through states: + +1. **`create`** — opens a review in `"PENDING"` state, optionally attaching inline comments. Nothing is visible to other users yet. +2. **`submit`** — finalizes the pending review with a terminal `state`: `"APPROVED"`, `"REQUEST_CHANGES"`, or `"COMMENT"`. This is the point at which the review becomes visible and counts toward merge-gate requirements (see `references/merging.md`). +3. **`dismiss`** — invalidates an already-submitted review (e.g. an approval that's no longer valid after force-push), with an optional `message` giving the reason. Dismissal does not delete the review record — it stays visible but marked dismissed. +4. **`delete`** — removes a review outright. Use only for a review that was never submitted (e.g. abandoning a `PENDING` draft); do not use `delete` to retract a submitted review — use `dismiss` instead. + +## `pull_request_review_write` + +**Parameters:** +- `method` (string, required) — `"create"` | `"submit"` | `"delete"` | `"dismiss"` +- `owner` (string, required) +- `repo` (string, required) +- `pull_number` (number, required) +- `review_id` (number, required for every method except `"create"`, which returns the ID to use for the follow-up `submit`/`delete`/`dismiss` call) +- `state` (string, optional) — `"APPROVED"` | `"REQUEST_CHANGES"` | `"COMMENT"` | `"PENDING"` — set on `"create"` (typically `"PENDING"`, or a terminal state to create-and-submit in one call if the server supports it) or `"submit"` (terminal state) +- `body` (string, optional) — overall review comment text +- `commit_id` (string, optional, for `"create"`) — anchors inline comments to a specific commit SHA (typically the PR's current head SHA from `pull_request_read method: "get"`) +- `message` (string, optional, for `"dismiss"`) — dismissal reason +- `comments` (array of objects, optional, for `"create"`) — inline comments, each: `{path, body, old_line_num, new_line_num}` — `path` is the file path, `body` is the comment text, `new_line_num` anchors to a line in the new (added) side of the diff, `old_line_num` anchors to a line in the old (removed) side; use whichever side the comment applies to, not both + +## Reading reviews (`pull_request_read`) + +- `method: "get_reviews"` — array of review summaries: `id`, `state`, `body`, `user` (login), `comments_count`, `submitted_at`, `html_url`, `stale` (bool — the PR was pushed to after this review was submitted, meaning it may be outdated), `official` (bool), `dismissed` (bool). +- `method: "get_review"` (requires `review_id`) — single review detail. +- `method: "get_review_comments"` (requires `review_id`) — array of inline comments: `id`, `body`, `path`, `position`, `old_position`, `diff_hunk`, `user`, `html_url`, `created_at`, `updated_at`. + +**`review_scomments` typo:** the full PR object returned by `pull_request_read method: "get"` includes a field named `review_scomments` (a count), not `review_comments` — a source-level misspelling in gitea-mcp v1.3.0's `slim.go`. Do not write code or instructions that reference `review_comments` on that response; it will always be `undefined`. This is distinct from the `get_review_comments` method above, which is spelled correctly and returns the actual comment objects. diff --git a/plugins/gitea/skills/gitea-prs/references/sources.md b/plugins/gitea/skills/gitea-prs/references/sources.md new file mode 100644 index 0000000..90d86a6 --- /dev/null +++ b/plugins/gitea/skills/gitea-prs/references/sources.md @@ -0,0 +1,33 @@ +# Sources + +## gitea-mcp-repo + +- **URL:** https://gitea.com/gitea/gitea-mcp +- **Description:** Official gitea-mcp repository (v1.3.0) — `operation/*.go` source files documenting all 55 MCP tools, their parameters, and CLI flags. Live tool schemas (`list_pull_requests`, `pull_request_read`, `pull_request_write`, `pull_request_review_write`) were verified directly against the deployed MCP server via `ToolSearch` at authoring time, per this repo's process for resolving schema-vs-docs drift, rather than copied from the derived research doc. +- **Research doc:** plugins/gitea/docs/research/docs/gitea/sources.md +- **Contributing files:** SKILL.md, references/pull-requests.md, references/reviews.md, references/merging.md +- **Status:** `extracted` + +## gitea-mcp-slim-go + +- **URL:** https://gitea.com/gitea/gitea-mcp/raw/branch/main/operation/pull/slim.go +- **Description:** Slim response shape structs from gitea-mcp source — defines exactly which fields the MCP server returns for PRs and reviews, including the `review_scomments` typo and the PR-response milestone-as-title-string quirk. +- **Research doc:** plugins/gitea/docs/research/docs/gitea/sources.md +- **Contributing files:** SKILL.md, references/pull-requests.md, references/reviews.md +- **Status:** `extracted` + +## context7-websites-gitea + +- **URL:** context7:/websites/gitea +- **Description:** Official Gitea docs mirror on Context7 — branch protection rules, PR review/merge gating behavior, and automatic issue/PR cross-reference linking. Backfills the external/best-practice gap left by the original docs.gitea.com fetch timeout. +- **Research doc:** plugins/gitea/docs/research/docs/gitea/sources.md +- **Contributing files:** SKILL.md, references/merging.md +- **Status:** `extracted` + +## context7-gitea-tea-cli + +- **URL:** context7:/git_gitea_com/gitea_tea +- **Description:** Official `tea` CLI (reference Gitea client) docs on Context7 — practitioner command patterns for PR review workflows. +- **Research doc:** plugins/gitea/docs/research/docs/gitea/sources.md +- **Contributing files:** references/merging.md +- **Status:** `extracted`