code-review-best-practices/example-guidelines/context/mcp-integration.yaml at main · augmentcode/code-review-best-practices · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# MCP Integration Code Review Guidelines
# =======================================
# These guidelines leverage MCP (Model Context Protocol) to fetch additional
# context from external tools like Linear, Jira, or other integrations.
#
# IMPORTANT: These rules will only work if the corresponding MCP servers
# are configured in your Augment Code Review setup. Without MCP configuration,
# these context sources will not be available.
#
# For MCP setup, see: https://docs.augmentcode.com/

description: "Guidelines that use MCP to fetch external context for more thorough code reviews"
globs:
  - "**"

areas:
  # ============================================================================
  # REVIEW CONTEXT
  # Rules that pull in context from issue trackers and project management tools
  # ============================================================================
  review_context:
    description: "Fetch context from Linear, Jira, or other tools via MCP to verify implementation matches requirements"
    globs:
      - "**"
    rules:
      # --------------------------------------------------------------------------
      # Linear Integration
      # Requires: Linear MCP server configured
      # --------------------------------------------------------------------------
      - id: "verify-linear-ticket-requirements"
        description: >
          When a PR references a Linear ticket (e.g., ENG-123 in branch name or PR description),
          fetch the ticket details via MCP to verify the implementation matches the acceptance
          criteria and expected behavior described in the ticket.
        severity: "high"

      - id: "check-linear-ticket-scope"
        description: >
          Compare the changes in the PR against the Linear ticket scope. Flag if the PR
          appears to include changes unrelated to the ticket, or if the ticket requirements
          don't seem fully addressed by the changes.
        severity: "medium"

      - id: "verify-linear-subtasks-completed"
        description: >
          If the Linear ticket has subtasks or a checklist, verify that the PR addresses
          all items. Highlight any subtasks that don't appear to be covered by the changes.
        severity: "medium"

      # --------------------------------------------------------------------------
      # Jira Integration
      # Requires: Jira MCP server configured
      # --------------------------------------------------------------------------
      - id: "verify-jira-ticket-requirements"
        description: >
          When a PR references a Jira ticket (e.g., PROJ-456 in branch name or PR description),
          fetch the ticket details via MCP to verify the implementation matches the acceptance
          criteria, user story, and expected behavior described in the ticket.
        severity: "high"

      - id: "check-jira-ticket-type"
        description: >
          Fetch the Jira ticket type (bug, feature, task, etc.) and verify the PR changes
          are appropriate. Bug fixes should include regression tests. Features should have
          documentation updates if user-facing.
        severity: "medium"

      - id: "verify-jira-linked-issues"
        description: >
          Check for linked Jira issues (blocks, is blocked by, relates to) and ensure
          the PR doesn't introduce conflicts with related work or dependencies.
        severity: "low"

      # --------------------------------------------------------------------------
      # General Context Rules
      # --------------------------------------------------------------------------
      - id: "match-pr-to-ticket-description"
        description: >
          Cross-reference the PR description and changes against the linked ticket's
          description. Ensure the "why" of the change aligns with the ticket's stated
          problem or goal.
        severity: "medium"

      - id: "verify-edge-cases-from-ticket"
        description: >
          Review any edge cases, error scenarios, or special conditions mentioned in
          the ticket. Verify the code handles these cases appropriately and includes
          relevant test coverage.
        severity: "high"

      - id: "check-ticket-comments-for-context"
        description: >
          Fetch comments from the linked ticket to understand any discussions, decisions,
          or clarifications that might affect the expected implementation. Flag if the
          implementation contradicts decisions recorded in comments.
        severity: "low"

      - id: "verify-acceptance-criteria-testability"
        description: >
          For each acceptance criterion in the ticket, verify there is a corresponding
          test or clear way to validate the behavior. Flag acceptance criteria that
          appear untested.
        severity: "medium"

      - id: "flag-missing-ticket-reference"
        description: >
          If a PR lacks a ticket reference in the branch name, PR title, or description,
          flag it for review. All production code changes should be traceable to a ticket
          for audit and tracking purposes.
        severity: "low"