python-sdk/.github/workflows/shared.yml at 27290cf928c58b0deab5fcd1a1640b073eb7377a · modelcontextprotocol/python-sdk · 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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
name: Shared Checks

on:
  workflow_call:

permissions:
  contents: read

env:
  COLUMNS: 150

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          enable-cache: true
          version: 0.9.5
      - name: Install dependencies
        run: uv sync --frozen --all-extras --python 3.10

      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
        with:
          extra_args: --all-files --verbose
        env:
          SKIP: no-commit-to-branch,readme-v1-frozen

      - name: Surface types match vendored schema
        run: |
          uv sync --group codegen --frozen
          uv run --frozen --group codegen python scripts/gen_surface_types.py --check

      # Resolves only mcp-types' declared dependencies into an empty environment,
      # so an import of the SDK or anything from its stack fails here.
      - name: mcp-types installs and imports standalone
        run: |
          uv run --isolated --no-project --with ./src/mcp-types python -c \
            "import mcp_types, mcp_types.jsonrpc, mcp_types.methods, mcp_types.version, mcp_types.v2025_11_25, mcp_types.v2026_07_28"

      # TODO(Max): Drop this in v2. Deliberate updates (e.g. the v2 status
      # banner) go through the 'override-readme-freeze' label.
      - name: Check README.md is not modified
        if: github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'override-readme-freeze')
        run: |
          git fetch --no-tags --depth=1 origin "$BASE_SHA"
          if git diff --name-only "$BASE_SHA" -- README.md | grep -q .; then
            echo "::error::README.md is frozen at v1. Edit README.v2.md instead."
            exit 1
          fi
        env:
          BASE_SHA: ${{ github.event.pull_request.base.sha }}

  test:
    name: test (${{ matrix.python-version }}, ${{ matrix.dep-resolution.name }}, ${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    timeout-minutes: 10
    continue-on-error: true
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
        dep-resolution:
          - name: lowest-direct
            install-flags: "--upgrade --resolution lowest-direct"
          - name: locked
            install-flags: "--frozen"
        os: [ubuntu-latest, windows-latest]

    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - name: Install uv
        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          enable-cache: true
          version: 0.9.5

      - name: Install the project
        run: uv sync ${{ matrix.dep-resolution.install-flags }} --all-extras --python ${{ matrix.python-version }}

      - name: Run pytest with coverage
        shell: bash
        env:
          # tests/examples/test_stories_smoke.py is gated on this var; it spawns real
          # stdio + uvicorn subprocesses, so run it on exactly one matrix cell.
          MCP_EXAMPLES_SMOKE: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12' && matrix.dep-resolution.name == 'locked' && '1' || '' }}
        run: |
          uv run --frozen --no-sync coverage erase
          uv run --frozen --no-sync coverage run -m pytest -n auto
          uv run --frozen --no-sync coverage combine
          uv run --frozen --no-sync coverage report

      - name: Check for unnecessary no cover pragmas
        if: runner.os != 'Windows'
        run: uv run --frozen --no-sync strict-no-cover

  readme-snippets:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          enable-cache: true
          version: 0.9.5

      - name: Install dependencies
        run: uv sync --frozen --all-extras --python 3.10

      - name: Check README snippets are up to date
        run: uv run --frozen scripts/update_readme_snippets.py --check --readme README.v2.md

  # `mkdocs.yml` sets `strict: true` and `pymdownx.snippets: check_paths: true`,
  # but until this job existed the docs were only ever built post-merge by
  # `deploy-docs.yml`, so a broken link, a missing nav target, or a deleted
  # `docs_src/` include went green on the PR and broke the next deploy of main.
  # This is the check path; `deploy-docs.yml` stays the deploy path.
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          enable-cache: true
          version: 0.9.5

      - name: Install dependencies
        run: uv sync --frozen --all-extras --python 3.10

      - name: Build the docs in strict mode
        run: uv run --frozen --no-sync mkdocs build --strict