pmcp 2.3.0

High-quality Rust SDK for Model Context Protocol (MCP) with full TypeScript SDK compatibility
Documentation 
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
143
144
145
146
147
148
149
150

name: Build and Deploy PMCP Course

on:
  push:
    branches: [ main ]
    paths:
      - 'pmcp-course/**'
      - '.github/workflows/course.yml'
  pull_request:
    branches: [ main ]
    paths:
      - 'pmcp-course/**'
      - '.github/workflows/course.yml'
  release:
    types: [published]
  workflow_dispatch:

permissions:
  contents: write

concurrency:
  group: "course-build"
  cancel-in-progress: true

jobs:
  # Build the course book
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable

      - name: Install mdBook
        run: |
          curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz
          chmod +x mdbook
          sudo mv mdbook /usr/local/bin/

      - name: Install mdbook-quiz
        run: |
          cargo install mdbook-quiz --locked || echo "mdbook-quiz installation failed, continuing without quiz support"

      - name: Install mdbook-exercises
        run: |
          cargo install mdbook-exercises --locked || echo "mdbook-exercises installation failed, continuing without exercise support"

      - name: Build Course Book
        run: |
          cd pmcp-course
          mdbook build

      - name: Upload book artifact
        uses: actions/upload-artifact@v7
        with:
          name: course-book
          path: pmcp-course/book
          retention-days: 7

  # Package course content for pmcp.run consumption
  package-content:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Create course content package
        run: |
          # Package content (excluding book output)
          # Structure: part1-foundations/, exercises/, quizzes/, metadata.toml
          # The transform strips pmcp-course/src/ to create flat structure matching metadata.toml paths
          tar -czf course-content.tar.gz \
            --transform 's,^pmcp-course/src/,,' \
            --transform 's,^pmcp-course/,,' \
            pmcp-course/src/ \
            pmcp-course/metadata.toml

          # Show package contents
          echo "Package contents:"
          tar -tzf course-content.tar.gz | head -50

          # Show package size
          ls -lh course-content.tar.gz

      - name: Upload content artifact
        uses: actions/upload-artifact@v7
        with:
          name: course-content
          path: course-content.tar.gz
          retention-days: 30

  # Upload content package to release (only on release)
  upload-to-release:
    if: github.event_name == 'release'
    needs: [build, package-content]
    runs-on: ubuntu-latest
    steps:
      - name: Download content artifact
        uses: actions/download-artifact@v8
        with:
          name: course-content

      - name: Rename with version
        run: |
          mv course-content.tar.gz course-content-${{ github.ref_name }}.tar.gz
          ls -lh course-content-*.tar.gz

      - name: Upload to release
        uses: softprops/action-gh-release@v2
        with:
          files: course-content-${{ github.ref_name }}.tar.gz
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  # NOTE: Deployment to GitHub Pages is handled by docs.yml workflow
  # which creates a combined site with landing page, /book/, and /course/
  # This workflow only builds and packages course content

  # Validate examples compile (on PR)
  validate-examples:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache cargo
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: "examples/27-course-server-minimal"

      - name: Build course-server-minimal example
        run: |
          cd examples/27-course-server-minimal
          cargo build

      - name: Test content loading
        run: |
          cd examples/27-course-server-minimal
          CONTENT_DIR=../../pmcp-course/src cargo build
          echo "Content loading validated"