mcp-probe/docs/example-workflow.yml at main · markndg/mcp-probe · 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
# Drop this file into `.github/workflows/mcp-probe.yml` of your MCP server repository.
#
# It runs mcp-probe's built-in conformance pack against your server on every push and
# pull request, and uploads a SARIF report so failures appear in the GitHub Code
# Scanning tab — alongside CVE findings and secret scanning alerts.
#
# Replace `npx -y @modelcontextprotocol/server-memory` with whatever spawns *your*
# stdio MCP server. For a suite file, set `suite:` instead of `server-command:`.

name: MCP conformance

on:
  push:
    branches: [main]
  pull_request:

jobs:
  mcp-probe:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      security-events: write   # required for SARIF upload to Code Scanning
    steps:
      - uses: actions/checkout@v4

      # The action defaults to building from source — for fastest runs, pin to a
      # released tag so it downloads a prebuilt binary instead.
      - uses: markndg/mcp-probe@v0.2.0
        with:
          server-command: npx
          server-args: "-y @modelcontextprotocol/server-memory"
          version: v0.2.0
          # All optional:
          # protocol-version: 2024-11-05
          # timeout-ms: 15000
          # pack: builtin
          # suite: tests/mcp/my-suite.json